From 1c6e35fe40d3efa9f2f6e4005cb3246398b9aefe Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 8 Feb 2024 11:45:05 +0530 Subject: [PATCH] 4.19 support changes --- cloudstack/AddressService.go | 23 +- cloudstack/AddressService_mock.go | 8 +- cloudstack/AffinityGroupService.go | 3 + cloudstack/AutoScaleService.go | 92 + cloudstack/BrocadeVCSService.go | 1 + cloudstack/ConfigurationService.go | 1 + cloudstack/DiskOfferingService.go | 54 + cloudstack/GuestOSService.go | 66 +- cloudstack/HostService.go | 28 + cloudstack/ISOService.go | 42 + cloudstack/KubernetesService.go | 27 +- cloudstack/KubernetesService_mock.go | 8 +- cloudstack/NetworkACLService.go | 7 +- cloudstack/NetworkACLService_mock.go | 8 +- cloudstack/NetworkService.go | 6 + cloudstack/NicService.go | 5 + cloudstack/PoolService.go | 100 + cloudstack/SSHService.go | 3 + cloudstack/ServiceOfferingService.go | 54 + cloudstack/SnapshotService.go | 372 +- cloudstack/StoragePoolService.go | 2 + cloudstack/SystemVMService.go | 16 + cloudstack/TemplateService.go | 150 +- cloudstack/TemplateService_mock.go | 8 +- cloudstack/VirtualMachineService.go | 128 + cloudstack/ZoneService.go | 38 + generate/listApis.json | 165657 +++++++++++++----------- test/AddressService_test.go | 2 +- test/KubernetesService_test.go | 2 +- test/NetworkACLService_test.go | 2 +- test/TemplateService_test.go | 2 +- 31 files changed, 88022 insertions(+), 78893 deletions(-) diff --git a/cloudstack/AddressService.go b/cloudstack/AddressService.go index 12165a13..56aeb1ec 100644 --- a/cloudstack/AddressService.go +++ b/cloudstack/AddressService.go @@ -31,7 +31,7 @@ type AddressServiceIface interface { AssociateIpAddress(p *AssociateIpAddressParams) (*AssociateIpAddressResponse, error) NewAssociateIpAddressParams() *AssociateIpAddressParams DisassociateIpAddress(p *DisassociateIpAddressParams) (*DisassociateIpAddressResponse, error) - NewDisassociateIpAddressParams(id string) *DisassociateIpAddressParams + NewDisassociateIpAddressParams() *DisassociateIpAddressParams ListPublicIpAddresses(p *ListPublicIpAddressesParams) (*ListPublicIpAddressesResponse, error) NewListPublicIpAddressesParams() *ListPublicIpAddressesParams GetPublicIpAddressByID(id string, opts ...OptionFunc) (*PublicIpAddress, int, error) @@ -331,6 +331,9 @@ func (p *DisassociateIpAddressParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["ipaddress"]; found { + u.Set("ipaddress", v.(string)) + } return u } @@ -349,12 +352,26 @@ func (p *DisassociateIpAddressParams) GetId() (string, bool) { return value, ok } +func (p *DisassociateIpAddressParams) SetIpaddress(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ipaddress"] = v +} + +func (p *DisassociateIpAddressParams) GetIpaddress() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ipaddress"].(string) + return value, ok +} + // You should always use this function to get a new DisassociateIpAddressParams instance, // as then you are sure you have configured all required params -func (s *AddressService) NewDisassociateIpAddressParams(id string) *DisassociateIpAddressParams { +func (s *AddressService) NewDisassociateIpAddressParams() *DisassociateIpAddressParams { p := &DisassociateIpAddressParams{} p.p = make(map[string]interface{}) - p.p["id"] = id return p } diff --git a/cloudstack/AddressService_mock.go b/cloudstack/AddressService_mock.go index fb587a8e..a63c8eb9 100644 --- a/cloudstack/AddressService_mock.go +++ b/cloudstack/AddressService_mock.go @@ -133,17 +133,17 @@ func (mr *MockAddressServiceIfaceMockRecorder) NewAssociateIpAddressParams() *go } // NewDisassociateIpAddressParams mocks base method. -func (m *MockAddressServiceIface) NewDisassociateIpAddressParams(id string) *DisassociateIpAddressParams { +func (m *MockAddressServiceIface) NewDisassociateIpAddressParams() *DisassociateIpAddressParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewDisassociateIpAddressParams", id) + ret := m.ctrl.Call(m, "NewDisassociateIpAddressParams") ret0, _ := ret[0].(*DisassociateIpAddressParams) return ret0 } // NewDisassociateIpAddressParams indicates an expected call of NewDisassociateIpAddressParams. -func (mr *MockAddressServiceIfaceMockRecorder) NewDisassociateIpAddressParams(id interface{}) *gomock.Call { +func (mr *MockAddressServiceIfaceMockRecorder) NewDisassociateIpAddressParams() *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDisassociateIpAddressParams", reflect.TypeOf((*MockAddressServiceIface)(nil).NewDisassociateIpAddressParams), id) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDisassociateIpAddressParams", reflect.TypeOf((*MockAddressServiceIface)(nil).NewDisassociateIpAddressParams)) } // NewListPublicIpAddressesParams mocks base method. diff --git a/cloudstack/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index 10264f04..20692a66 100644 --- a/cloudstack/AffinityGroupService.go +++ b/cloudstack/AffinityGroupService.go @@ -1026,6 +1026,7 @@ type UpdateVMAffinityGroupResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -1034,6 +1035,8 @@ type UpdateVMAffinityGroupResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/AutoScaleService.go b/cloudstack/AutoScaleService.go index b14e12ff..2791d08e 100644 --- a/cloudstack/AutoScaleService.go +++ b/cloudstack/AutoScaleService.go @@ -560,6 +560,16 @@ func (p *CreateAutoScaleVmProfileParams) 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)) } @@ -731,6 +741,36 @@ func (p *CreateAutoScaleVmProfileParams) GetUserdata() (string, bool) { return value, ok } +func (p *CreateAutoScaleVmProfileParams) SetUserdatadetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdatadetails"] = v +} + +func (p *CreateAutoScaleVmProfileParams) 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 *CreateAutoScaleVmProfileParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *CreateAutoScaleVmProfileParams) GetUserdataid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdataid"].(string) + return value, ok +} + func (p *CreateAutoScaleVmProfileParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -808,6 +848,10 @@ type CreateAutoScaleVmProfileResponse struct { Serviceofferingid string `json:"serviceofferingid"` Templateid string `json:"templateid"` Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` } @@ -2898,6 +2942,10 @@ type AutoScaleVmProfile struct { Serviceofferingid string `json:"serviceofferingid"` Templateid string `json:"templateid"` Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` } @@ -3924,6 +3972,16 @@ func (p *UpdateAutoScaleVmProfileParams) 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 } @@ -4077,6 +4135,36 @@ func (p *UpdateAutoScaleVmProfileParams) GetUserdata() (string, bool) { return value, ok } +func (p *UpdateAutoScaleVmProfileParams) SetUserdatadetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdatadetails"] = v +} + +func (p *UpdateAutoScaleVmProfileParams) 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 *UpdateAutoScaleVmProfileParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *UpdateAutoScaleVmProfileParams) 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 UpdateAutoScaleVmProfileParams instance, // as then you are sure you have configured all required params func (s *AutoScaleService) NewUpdateAutoScaleVmProfileParams(id string) *UpdateAutoScaleVmProfileParams { @@ -4137,5 +4225,9 @@ type UpdateAutoScaleVmProfileResponse struct { Serviceofferingid string `json:"serviceofferingid"` Templateid string `json:"templateid"` Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` } diff --git a/cloudstack/BrocadeVCSService.go b/cloudstack/BrocadeVCSService.go index 03eb5cf6..17fb14ce 100644 --- a/cloudstack/BrocadeVCSService.go +++ b/cloudstack/BrocadeVCSService.go @@ -426,6 +426,7 @@ type BrocadeVcsDeviceNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index fc1e5b33..0284af18 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -88,6 +88,7 @@ type Capability struct { Cloudstackversion string `json:"cloudstackversion"` Customdiskofferingmaxsize int64 `json:"customdiskofferingmaxsize"` Customdiskofferingminsize int64 `json:"customdiskofferingminsize"` + Customhypervisordisplayname string `json:"customhypervisordisplayname"` Defaultuipagesize int64 `json:"defaultuipagesize"` Dynamicrolesenabled bool `json:"dynamicrolesenabled"` Instancesdisksstatsretentionenabled bool `json:"instancesdisksstatsretentionenabled"` diff --git a/cloudstack/DiskOfferingService.go b/cloudstack/DiskOfferingService.go index 385fece6..7be7770a 100644 --- a/cloudstack/DiskOfferingService.go +++ b/cloudstack/DiskOfferingService.go @@ -803,6 +803,9 @@ func (p *ListDiskOfferingsParams) 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["domainid"]; found { u.Set("domainid", v.(string)) } @@ -835,9 +838,15 @@ func (p *ListDiskOfferingsParams) 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["storageid"]; found { u.Set("storageid", v.(string)) } + if v, found := p.p["storagetype"]; found { + u.Set("storagetype", v.(string)) + } if v, found := p.p["volumeid"]; found { u.Set("volumeid", v.(string)) } @@ -847,6 +856,21 @@ func (p *ListDiskOfferingsParams) toURLValues() url.Values { return u } +func (p *ListDiskOfferingsParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *ListDiskOfferingsParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + func (p *ListDiskOfferingsParams) SetDomainid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -982,6 +1006,21 @@ func (p *ListDiskOfferingsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListDiskOfferingsParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListDiskOfferingsParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + func (p *ListDiskOfferingsParams) SetStorageid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -997,6 +1036,21 @@ func (p *ListDiskOfferingsParams) GetStorageid() (string, bool) { return value, ok } +func (p *ListDiskOfferingsParams) SetStoragetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storagetype"] = v +} + +func (p *ListDiskOfferingsParams) GetStoragetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storagetype"].(string) + return value, ok +} + func (p *ListDiskOfferingsParams) SetVolumeid(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/GuestOSService.go b/cloudstack/GuestOSService.go index ca2819d0..2782c9c1 100644 --- a/cloudstack/GuestOSService.go +++ b/cloudstack/GuestOSService.go @@ -71,6 +71,10 @@ func (p *AddGuestOsParams) toURLValues() url.Values { u.Set(fmt.Sprintf("details[%d].value", i), m[k]) } } + if v, found := p.p["forDisplay"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forDisplay", vv) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -98,6 +102,21 @@ func (p *AddGuestOsParams) GetDetails() (map[string]string, bool) { return value, ok } +func (p *AddGuestOsParams) SetForDisplay(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forDisplay"] = v +} + +func (p *AddGuestOsParams) GetForDisplay() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forDisplay"].(bool) + return value, ok +} + func (p *AddGuestOsParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -190,8 +209,9 @@ func (s *GuestOSService) AddGuestOs(p *AddGuestOsParams) (*AddGuestOsResponse, e type AddGuestOsResponse struct { Description string `json:"description"` + Fordisplay bool `json:"fordisplay"` Id string `json:"id"` - Isuserdefined string `json:"isuserdefined"` + Isuserdefined bool `json:"isuserdefined"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -934,6 +954,10 @@ func (p *ListOsTypesParams) toURLValues() url.Values { if v, found := p.p["description"]; found { u.Set("description", v.(string)) } + if v, found := p.p["fordisplay"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fordisplay", vv) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -969,6 +993,21 @@ func (p *ListOsTypesParams) GetDescription() (string, bool) { return value, ok } +func (p *ListOsTypesParams) SetFordisplay(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fordisplay"] = v +} + +func (p *ListOsTypesParams) GetFordisplay() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fordisplay"].(bool) + return value, ok +} + func (p *ListOsTypesParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1157,8 +1196,9 @@ type ListOsTypesResponse struct { type OsType struct { Description string `json:"description"` + Fordisplay bool `json:"fordisplay"` Id string `json:"id"` - Isuserdefined string `json:"isuserdefined"` + Isuserdefined bool `json:"isuserdefined"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -1334,6 +1374,10 @@ func (p *UpdateGuestOsParams) toURLValues() url.Values { u.Set(fmt.Sprintf("details[%d].value", i), m[k]) } } + if v, found := p.p["forDisplay"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forDisplay", vv) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -1358,6 +1402,21 @@ func (p *UpdateGuestOsParams) GetDetails() (map[string]string, bool) { return value, ok } +func (p *UpdateGuestOsParams) SetForDisplay(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forDisplay"] = v +} + +func (p *UpdateGuestOsParams) GetForDisplay() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forDisplay"].(bool) + return value, ok +} + func (p *UpdateGuestOsParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1435,8 +1494,9 @@ func (s *GuestOSService) UpdateGuestOs(p *UpdateGuestOsParams) (*UpdateGuestOsRe type UpdateGuestOsResponse struct { Description string `json:"description"` + Fordisplay bool `json:"fordisplay"` Id string `json:"id"` - Isuserdefined string `json:"isuserdefined"` + Isuserdefined bool `json:"isuserdefined"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` diff --git a/cloudstack/HostService.go b/cloudstack/HostService.go index b29f87f6..5293daa6 100644 --- a/cloudstack/HostService.go +++ b/cloudstack/HostService.go @@ -353,6 +353,7 @@ type AddBaremetalHostResponse struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` @@ -791,6 +792,7 @@ type AddHostResponse struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` @@ -1035,6 +1037,7 @@ type CancelHostMaintenanceResponse struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` @@ -2654,6 +2657,7 @@ type Host struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` @@ -3177,6 +3181,7 @@ type HostsMetric struct { Instances string `json:"instances"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` @@ -3210,6 +3215,7 @@ type HostsMetric struct { Resourcestate string `json:"resourcestate"` State string `json:"state"` Suitableformigration bool `json:"suitableformigration"` + Systeminstances string `json:"systeminstances"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` @@ -3342,6 +3348,7 @@ type PrepareHostForMaintenanceResponse struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` @@ -3497,6 +3504,7 @@ type ReconnectHostResponse struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` @@ -3718,6 +3726,10 @@ func (p *UpdateHostParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["istagarule"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("istagarule", vv) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -3790,6 +3802,21 @@ func (p *UpdateHostParams) GetId() (string, bool) { return value, ok } +func (p *UpdateHostParams) SetIstagarule(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["istagarule"] = v +} + +func (p *UpdateHostParams) GetIstagarule() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["istagarule"].(bool) + return value, ok +} + func (p *UpdateHostParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3893,6 +3920,7 @@ type UpdateHostResponse struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastannotated string `json:"lastannotated"` diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index f5519381..7f4a08fb 100644 --- a/cloudstack/ISOService.go +++ b/cloudstack/ISOService.go @@ -242,6 +242,7 @@ type AttachIsoResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -250,6 +251,8 @@ type AttachIsoResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -799,6 +802,7 @@ type DetachIsoResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -807,6 +811,8 @@ type DetachIsoResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1155,6 +1161,9 @@ func (p *ListIsosParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["imagestoreid"]; found { + u.Set("imagestoreid", v.(string)) + } if v, found := p.p["isofilter"]; found { u.Set("isofilter", v.(string)) } @@ -1203,6 +1212,9 @@ func (p *ListIsosParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showunique", vv) } + if v, found := p.p["storageid"]; found { + u.Set("storageid", v.(string)) + } if v, found := p.p["tags"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -1291,6 +1303,21 @@ func (p *ListIsosParams) GetId() (string, bool) { return value, ok } +func (p *ListIsosParams) SetImagestoreid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["imagestoreid"] = v +} + +func (p *ListIsosParams) GetImagestoreid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["imagestoreid"].(string) + return value, ok +} + func (p *ListIsosParams) SetIsofilter(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1486,6 +1513,21 @@ func (p *ListIsosParams) GetShowunique() (bool, bool) { return value, ok } +func (p *ListIsosParams) SetStorageid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageid"] = v +} + +func (p *ListIsosParams) GetStorageid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageid"].(string) + return value, ok +} + func (p *ListIsosParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index 8e92ecf7..80e4be87 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -31,7 +31,7 @@ type KubernetesServiceIface interface { AddKubernetesSupportedVersion(p *AddKubernetesSupportedVersionParams) (*AddKubernetesSupportedVersionResponse, error) NewAddKubernetesSupportedVersionParams(mincpunumber int, minmemory int, semanticversion string) *AddKubernetesSupportedVersionParams CreateKubernetesCluster(p *CreateKubernetesClusterParams) (*CreateKubernetesClusterResponse, error) - NewCreateKubernetesClusterParams(clustertype string, name string, zoneid string) *CreateKubernetesClusterParams + NewCreateKubernetesClusterParams(name string, zoneid string) *CreateKubernetesClusterParams DeleteKubernetesCluster(p *DeleteKubernetesClusterParams) (*DeleteKubernetesClusterResponse, error) NewDeleteKubernetesClusterParams(id string) *DeleteKubernetesClusterParams DeleteKubernetesSupportedVersion(p *DeleteKubernetesSupportedVersionParams) (*DeleteKubernetesSupportedVersionResponse, error) @@ -76,6 +76,10 @@ func (p *AddKubernetesSupportedVersionParams) toURLValues() url.Values { if v, found := p.p["checksum"]; found { u.Set("checksum", v.(string)) } + if v, found := p.p["directdownload"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("directdownload", vv) + } if v, found := p.p["mincpunumber"]; found { vv := strconv.Itoa(v.(int)) u.Set("mincpunumber", vv) @@ -114,6 +118,21 @@ func (p *AddKubernetesSupportedVersionParams) GetChecksum() (string, bool) { return value, ok } +func (p *AddKubernetesSupportedVersionParams) SetDirectdownload(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["directdownload"] = v +} + +func (p *AddKubernetesSupportedVersionParams) GetDirectdownload() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["directdownload"].(bool) + return value, ok +} + func (p *AddKubernetesSupportedVersionParams) SetMincpunumber(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -236,6 +255,7 @@ func (s *KubernetesService) AddKubernetesSupportedVersion(p *AddKubernetesSuppor type AddKubernetesSupportedVersionResponse struct { Created string `json:"created"` + Directdownload bool `json:"directdownload"` Id string `json:"id"` Isoid string `json:"isoid"` Isoname string `json:"isoname"` @@ -613,10 +633,9 @@ func (p *CreateKubernetesClusterParams) GetZoneid() (string, bool) { // You should always use this function to get a new CreateKubernetesClusterParams instance, // as then you are sure you have configured all required params -func (s *KubernetesService) NewCreateKubernetesClusterParams(clustertype string, name string, zoneid string) *CreateKubernetesClusterParams { +func (s *KubernetesService) NewCreateKubernetesClusterParams(name string, zoneid string) *CreateKubernetesClusterParams { p := &CreateKubernetesClusterParams{} p.p = make(map[string]interface{}) - p.p["clustertype"] = clustertype p.p["name"] = name p.p["zoneid"] = zoneid return p @@ -1587,6 +1606,7 @@ type ListKubernetesSupportedVersionsResponse struct { type KubernetesSupportedVersion struct { Created string `json:"created"` + Directdownload bool `json:"directdownload"` Id string `json:"id"` Isoid string `json:"isoid"` Isoname string `json:"isoname"` @@ -2096,6 +2116,7 @@ func (s *KubernetesService) UpdateKubernetesSupportedVersion(p *UpdateKubernetes type UpdateKubernetesSupportedVersionResponse struct { Created string `json:"created"` + Directdownload bool `json:"directdownload"` Id string `json:"id"` Isoid string `json:"isoid"` Isoname string `json:"isoname"` diff --git a/cloudstack/KubernetesService_mock.go b/cloudstack/KubernetesService_mock.go index c0e92649..deeb3d1a 100644 --- a/cloudstack/KubernetesService_mock.go +++ b/cloudstack/KubernetesService_mock.go @@ -327,17 +327,17 @@ func (mr *MockKubernetesServiceIfaceMockRecorder) NewAddVirtualMachinesToKuberne } // NewCreateKubernetesClusterParams mocks base method. -func (m *MockKubernetesServiceIface) NewCreateKubernetesClusterParams(clustertype, name, zoneid string) *CreateKubernetesClusterParams { +func (m *MockKubernetesServiceIface) NewCreateKubernetesClusterParams(name, zoneid string) *CreateKubernetesClusterParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateKubernetesClusterParams", clustertype, name, zoneid) + ret := m.ctrl.Call(m, "NewCreateKubernetesClusterParams", name, zoneid) ret0, _ := ret[0].(*CreateKubernetesClusterParams) return ret0 } // NewCreateKubernetesClusterParams indicates an expected call of NewCreateKubernetesClusterParams. -func (mr *MockKubernetesServiceIfaceMockRecorder) NewCreateKubernetesClusterParams(clustertype, name, zoneid interface{}) *gomock.Call { +func (mr *MockKubernetesServiceIfaceMockRecorder) NewCreateKubernetesClusterParams(name, zoneid interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewCreateKubernetesClusterParams), clustertype, name, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewCreateKubernetesClusterParams), name, zoneid) } // NewDeleteKubernetesClusterParams mocks base method. diff --git a/cloudstack/NetworkACLService.go b/cloudstack/NetworkACLService.go index 475b1b6e..27a21885 100644 --- a/cloudstack/NetworkACLService.go +++ b/cloudstack/NetworkACLService.go @@ -31,7 +31,7 @@ type NetworkACLServiceIface interface { CreateNetworkACL(p *CreateNetworkACLParams) (*CreateNetworkACLResponse, error) NewCreateNetworkACLParams(protocol string) *CreateNetworkACLParams CreateNetworkACLList(p *CreateNetworkACLListParams) (*CreateNetworkACLListResponse, error) - NewCreateNetworkACLListParams(name string, vpcid string) *CreateNetworkACLListParams + NewCreateNetworkACLListParams(name string) *CreateNetworkACLListParams DeleteNetworkACL(p *DeleteNetworkACLParams) (*DeleteNetworkACLResponse, error) NewDeleteNetworkACLParams(id string) *DeleteNetworkACLParams DeleteNetworkACLList(p *DeleteNetworkACLListParams) (*DeleteNetworkACLListResponse, error) @@ -457,15 +457,14 @@ func (p *CreateNetworkACLListParams) GetVpcid() (string, bool) { // You should always use this function to get a new CreateNetworkACLListParams instance, // as then you are sure you have configured all required params -func (s *NetworkACLService) NewCreateNetworkACLListParams(name string, vpcid string) *CreateNetworkACLListParams { +func (s *NetworkACLService) NewCreateNetworkACLListParams(name string) *CreateNetworkACLListParams { p := &CreateNetworkACLListParams{} p.p = make(map[string]interface{}) p.p["name"] = name - p.p["vpcid"] = vpcid return p } -// Creates a network ACL for the given VPC +// Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone. func (s *NetworkACLService) CreateNetworkACLList(p *CreateNetworkACLListParams) (*CreateNetworkACLListResponse, error) { resp, err := s.cs.newRequest("createNetworkACLList", p.toURLValues()) if err != nil { diff --git a/cloudstack/NetworkACLService_mock.go b/cloudstack/NetworkACLService_mock.go index 3d261653..ccba6ddc 100644 --- a/cloudstack/NetworkACLService_mock.go +++ b/cloudstack/NetworkACLService_mock.go @@ -227,17 +227,17 @@ func (mr *MockNetworkACLServiceIfaceMockRecorder) ListNetworkACLs(p interface{}) } // NewCreateNetworkACLListParams mocks base method. -func (m *MockNetworkACLServiceIface) NewCreateNetworkACLListParams(name, vpcid string) *CreateNetworkACLListParams { +func (m *MockNetworkACLServiceIface) NewCreateNetworkACLListParams(name string) *CreateNetworkACLListParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateNetworkACLListParams", name, vpcid) + ret := m.ctrl.Call(m, "NewCreateNetworkACLListParams", name) ret0, _ := ret[0].(*CreateNetworkACLListParams) return ret0 } // NewCreateNetworkACLListParams indicates an expected call of NewCreateNetworkACLListParams. -func (mr *MockNetworkACLServiceIfaceMockRecorder) NewCreateNetworkACLListParams(name, vpcid interface{}) *gomock.Call { +func (mr *MockNetworkACLServiceIfaceMockRecorder) NewCreateNetworkACLListParams(name interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateNetworkACLListParams", reflect.TypeOf((*MockNetworkACLServiceIface)(nil).NewCreateNetworkACLListParams), name, vpcid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateNetworkACLListParams", reflect.TypeOf((*MockNetworkACLServiceIface)(nil).NewCreateNetworkACLListParams), name) } // NewCreateNetworkACLParams mocks base method. diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index 519ed6ef..929dd900 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -1165,6 +1165,7 @@ type CreateNetworkResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` @@ -2596,6 +2597,7 @@ type NetscalerLoadBalancerNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` @@ -3655,6 +3657,7 @@ type Network struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` @@ -3904,6 +3907,7 @@ type NiciraNvpDeviceNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` @@ -4272,6 +4276,7 @@ type PaloAltoFirewallNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` @@ -5597,6 +5602,7 @@ type UpdateNetworkResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` diff --git a/cloudstack/NicService.go b/cloudstack/NicService.go index ed048c66..fbbb1c9f 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -337,6 +337,8 @@ type Nic struct { Networkname string `json:"networkname"` Nsxlogicalswitch string `json:"nsxlogicalswitch"` Nsxlogicalswitchport string `json:"nsxlogicalswitchport"` + Publicip string `json:"publicip"` + Publicipid string `json:"publicipid"` Secondaryip []struct { Id string `json:"id"` Ipaddress string `json:"ipaddress"` @@ -593,6 +595,7 @@ type UpdateVmNicIpResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -601,6 +604,8 @@ type UpdateVmNicIpResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/PoolService.go b/cloudstack/PoolService.go index aaa50bdb..3b1fdc53 100644 --- a/cloudstack/PoolService.go +++ b/cloudstack/PoolService.go @@ -74,6 +74,10 @@ func (p *CreateStoragePoolParams) toURLValues() url.Values { if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } + if v, found := p.p["istagarule"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("istagarule", vv) + } if v, found := p.p["managed"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("managed", vv) @@ -177,6 +181,21 @@ func (p *CreateStoragePoolParams) GetHypervisor() (string, bool) { return value, ok } +func (p *CreateStoragePoolParams) SetIstagarule(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["istagarule"] = v +} + +func (p *CreateStoragePoolParams) GetIstagarule() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["istagarule"].(bool) + return value, ok +} + func (p *CreateStoragePoolParams) SetManaged(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -340,6 +359,7 @@ type CreateStoragePoolResponse struct { Hypervisor string `json:"hypervisor"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -588,6 +608,7 @@ type FindStoragePoolsForMigrationResponse struct { Hypervisor string `json:"hypervisor"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -618,6 +639,9 @@ func (p *ListStoragePoolsParams) toURLValues() url.Values { if v, found := p.p["clusterid"]; found { u.Set("clusterid", v.(string)) } + if v, found := p.p["hostid"]; found { + u.Set("hostid", v.(string)) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -671,6 +695,21 @@ func (p *ListStoragePoolsParams) GetClusterid() (string, bool) { return value, ok } +func (p *ListStoragePoolsParams) SetHostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostid"] = v +} + +func (p *ListStoragePoolsParams) GetHostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostid"].(string) + return value, ok +} + func (p *ListStoragePoolsParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -960,6 +999,7 @@ type StoragePool struct { Hypervisor string `json:"hypervisor"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -1065,6 +1105,7 @@ type SyncStoragePoolResponse struct { Hypervisor string `json:"hypervisor"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -1100,6 +1141,12 @@ func (p *UpdateStoragePoolParams) toURLValues() url.Values { vv := strconv.FormatInt(v.(int64), 10) u.Set("capacityiops", vv) } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } if v, found := p.p["enabled"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("enabled", vv) @@ -1107,6 +1154,10 @@ func (p *UpdateStoragePoolParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["istagarule"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("istagarule", vv) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -1114,6 +1165,9 @@ func (p *UpdateStoragePoolParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("tags", vv) } + if v, found := p.p["url"]; found { + u.Set("url", v.(string)) + } return u } @@ -1147,6 +1201,21 @@ func (p *UpdateStoragePoolParams) GetCapacityiops() (int64, bool) { return value, ok } +func (p *UpdateStoragePoolParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *UpdateStoragePoolParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + func (p *UpdateStoragePoolParams) SetEnabled(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1177,6 +1246,21 @@ func (p *UpdateStoragePoolParams) GetId() (string, bool) { return value, ok } +func (p *UpdateStoragePoolParams) SetIstagarule(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["istagarule"] = v +} + +func (p *UpdateStoragePoolParams) GetIstagarule() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["istagarule"].(bool) + return value, ok +} + func (p *UpdateStoragePoolParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1207,6 +1291,21 @@ func (p *UpdateStoragePoolParams) GetTags() ([]string, bool) { return value, ok } +func (p *UpdateStoragePoolParams) SetUrl(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["url"] = v +} + +func (p *UpdateStoragePoolParams) GetUrl() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["url"].(string) + return value, ok +} + // You should always use this function to get a new UpdateStoragePoolParams instance, // as then you are sure you have configured all required params func (s *PoolService) NewUpdateStoragePoolParams(id string) *UpdateStoragePoolParams { @@ -1244,6 +1343,7 @@ type UpdateStoragePoolResponse struct { Hypervisor string `json:"hypervisor"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` diff --git a/cloudstack/SSHService.go b/cloudstack/SSHService.go index 2abe0bff..3067ec6a 100644 --- a/cloudstack/SSHService.go +++ b/cloudstack/SSHService.go @@ -1037,6 +1037,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -1045,6 +1046,8 @@ type ResetSSHKeyForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/ServiceOfferingService.go b/cloudstack/ServiceOfferingService.go index 6ba0ed23..8b9acd88 100644 --- a/cloudstack/ServiceOfferingService.go +++ b/cloudstack/ServiceOfferingService.go @@ -1119,6 +1119,9 @@ func (p *ListServiceOfferingsParams) 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["cpunumber"]; found { vv := strconv.Itoa(v.(int)) u.Set("cpunumber", vv) @@ -1167,6 +1170,12 @@ func (p *ListServiceOfferingsParams) 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["storagetype"]; found { + u.Set("storagetype", v.(string)) + } if v, found := p.p["systemvmtype"]; found { u.Set("systemvmtype", v.(string)) } @@ -1179,6 +1188,21 @@ func (p *ListServiceOfferingsParams) toURLValues() url.Values { return u } +func (p *ListServiceOfferingsParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *ListServiceOfferingsParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + func (p *ListServiceOfferingsParams) SetCpunumber(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1374,6 +1398,36 @@ func (p *ListServiceOfferingsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListServiceOfferingsParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListServiceOfferingsParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + +func (p *ListServiceOfferingsParams) SetStoragetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storagetype"] = v +} + +func (p *ListServiceOfferingsParams) GetStoragetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storagetype"].(string) + return value, ok +} + func (p *ListServiceOfferingsParams) SetSystemvmtype(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index 15bb2ce7..f26b546e 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -101,6 +101,10 @@ func (p *CreateSnapshotParams) toURLValues() url.Values { if v, found := p.p["volumeid"]; found { u.Set("volumeid", v.(string)) } + if v, found := p.p["zoneids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("zoneids", vv) + } return u } @@ -239,6 +243,21 @@ func (p *CreateSnapshotParams) GetVolumeid() (string, bool) { return value, ok } +func (p *CreateSnapshotParams) SetZoneids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneids"] = v +} + +func (p *CreateSnapshotParams) GetZoneids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneids"].([]string) + return value, ok +} + // You should always use this function to get a new CreateSnapshotParams instance, // as then you are sure you have configured all required params func (s *SnapshotService) NewCreateSnapshotParams(volumeid string) *CreateSnapshotParams { @@ -284,31 +303,38 @@ func (s *SnapshotService) CreateSnapshot(p *CreateSnapshotParams) (*CreateSnapsh } type CreateSnapshotResponse struct { - Account string `json:"account"` - Created string `json:"created"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Intervaltype string `json:"intervaltype"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Locationtype string `json:"locationtype"` - Name string `json:"name"` - Osdisplayname string `json:"osdisplayname"` - Ostypeid string `json:"ostypeid"` - Physicalsize int64 `json:"physicalsize"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Revertable bool `json:"revertable"` - Snapshottype string `json:"snapshottype"` - State string `json:"state"` - Tags []Tags `json:"tags"` - Virtualsize int64 `json:"virtualsize"` - Volumeid string `json:"volumeid"` - Volumename string `json:"volumename"` - Volumetype string `json:"volumetype"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Created string `json:"created"` + Datastoreid string `json:"datastoreid"` + Datastorename string `json:"datastorename"` + Datastorestate string `json:"datastorestate"` + Datastoretype string `json:"datastoretype"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Downloaddetails map[string]string `json:"downloaddetails"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Locationtype string `json:"locationtype"` + Name string `json:"name"` + Osdisplayname string `json:"osdisplayname"` + Ostypeid string `json:"ostypeid"` + Physicalsize int64 `json:"physicalsize"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Revertable bool `json:"revertable"` + Snapshottype string `json:"snapshottype"` + State string `json:"state"` + Status string `json:"status"` + Tags []Tags `json:"tags"` + Virtualsize int64 `json:"virtualsize"` + Volumeid string `json:"volumeid"` + Volumename string `json:"volumename"` + Volumetype string `json:"volumetype"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } func (r *CreateSnapshotResponse) UnmarshalJSON(b []byte) error { @@ -374,6 +400,10 @@ func (p *CreateSnapshotPolicyParams) toURLValues() url.Values { if v, found := p.p["volumeid"]; found { u.Set("volumeid", v.(string)) } + if v, found := p.p["zoneids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("zoneids", vv) + } return u } @@ -482,6 +512,21 @@ func (p *CreateSnapshotPolicyParams) GetVolumeid() (string, bool) { return value, ok } +func (p *CreateSnapshotPolicyParams) SetZoneids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneids"] = v +} + +func (p *CreateSnapshotPolicyParams) GetZoneids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneids"].([]string) + return value, ok +} + // You should always use this function to get a new CreateSnapshotPolicyParams instance, // as then you are sure you have configured all required params func (s *SnapshotService) NewCreateSnapshotPolicyParams(intervaltype string, maxsnaps int, schedule string, timezone string, volumeid string) *CreateSnapshotPolicyParams { @@ -511,17 +556,18 @@ func (s *SnapshotService) CreateSnapshotPolicy(p *CreateSnapshotPolicyParams) (* } type CreateSnapshotPolicyResponse struct { - Fordisplay bool `json:"fordisplay"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Intervaltype int `json:"intervaltype"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxsnaps int `json:"maxsnaps"` - Schedule string `json:"schedule"` - Tags []Tags `json:"tags"` - Timezone string `json:"timezone"` - Volumeid string `json:"volumeid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Intervaltype int `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxsnaps int `json:"maxsnaps"` + Schedule string `json:"schedule"` + Tags []Tags `json:"tags"` + Timezone string `json:"timezone"` + Volumeid string `json:"volumeid"` + Zone []interface{} `json:"zone"` } type CreateVMSnapshotParams struct { @@ -711,6 +757,9 @@ func (p *DeleteSnapshotParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } return u } @@ -729,6 +778,21 @@ func (p *DeleteSnapshotParams) GetId() (string, bool) { return value, ok } +func (p *DeleteSnapshotParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *DeleteSnapshotParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + // You should always use this function to get a new DeleteSnapshotParams instance, // as then you are sure you have configured all required params func (s *SnapshotService) NewDeleteSnapshotParams(id string) *DeleteSnapshotParams { @@ -1142,17 +1206,18 @@ type ListSnapshotPoliciesResponse struct { } type SnapshotPolicy struct { - Fordisplay bool `json:"fordisplay"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Intervaltype int `json:"intervaltype"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxsnaps int `json:"maxsnaps"` - Schedule string `json:"schedule"` - Tags []Tags `json:"tags"` - Timezone string `json:"timezone"` - Volumeid string `json:"volumeid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Intervaltype int `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxsnaps int `json:"maxsnaps"` + Schedule string `json:"schedule"` + Tags []Tags `json:"tags"` + Timezone string `json:"timezone"` + Volumeid string `json:"volumeid"` + Zone []interface{} `json:"zone"` } type ListSnapshotsParams struct { @@ -1177,6 +1242,9 @@ func (p *ListSnapshotsParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("ids", vv) } + if v, found := p.p["imagestoreid"]; found { + u.Set("imagestoreid", v.(string)) + } if v, found := p.p["intervaltype"]; found { u.Set("intervaltype", v.(string)) } @@ -1191,6 +1259,9 @@ func (p *ListSnapshotsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("listall", vv) } + if v, found := p.p["locationtype"]; found { + u.Set("locationtype", v.(string)) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -1205,9 +1276,16 @@ func (p *ListSnapshotsParams) toURLValues() url.Values { if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } + if v, found := p.p["showunique"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("showunique", vv) + } if v, found := p.p["snapshottype"]; found { u.Set("snapshottype", v.(string)) } + if v, found := p.p["storageid"]; found { + u.Set("storageid", v.(string)) + } if v, found := p.p["tags"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -1284,6 +1362,21 @@ func (p *ListSnapshotsParams) GetIds() ([]string, bool) { return value, ok } +func (p *ListSnapshotsParams) SetImagestoreid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["imagestoreid"] = v +} + +func (p *ListSnapshotsParams) GetImagestoreid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["imagestoreid"].(string) + return value, ok +} + func (p *ListSnapshotsParams) SetIntervaltype(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1344,6 +1437,21 @@ func (p *ListSnapshotsParams) GetListall() (bool, bool) { return value, ok } +func (p *ListSnapshotsParams) SetLocationtype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["locationtype"] = v +} + +func (p *ListSnapshotsParams) GetLocationtype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["locationtype"].(string) + return value, ok +} + func (p *ListSnapshotsParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1404,6 +1512,21 @@ func (p *ListSnapshotsParams) GetProjectid() (string, bool) { return value, ok } +func (p *ListSnapshotsParams) SetShowunique(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["showunique"] = v +} + +func (p *ListSnapshotsParams) GetShowunique() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["showunique"].(bool) + return value, ok +} + func (p *ListSnapshotsParams) SetSnapshottype(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1419,6 +1542,21 @@ func (p *ListSnapshotsParams) GetSnapshottype() (string, bool) { return value, ok } +func (p *ListSnapshotsParams) SetStorageid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageid"] = v +} + +func (p *ListSnapshotsParams) GetStorageid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageid"].(string) + return value, ok +} + func (p *ListSnapshotsParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1576,31 +1714,38 @@ type ListSnapshotsResponse struct { } type Snapshot struct { - Account string `json:"account"` - Created string `json:"created"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Intervaltype string `json:"intervaltype"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Locationtype string `json:"locationtype"` - Name string `json:"name"` - Osdisplayname string `json:"osdisplayname"` - Ostypeid string `json:"ostypeid"` - Physicalsize int64 `json:"physicalsize"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Revertable bool `json:"revertable"` - Snapshottype string `json:"snapshottype"` - State string `json:"state"` - Tags []Tags `json:"tags"` - Virtualsize int64 `json:"virtualsize"` - Volumeid string `json:"volumeid"` - Volumename string `json:"volumename"` - Volumetype string `json:"volumetype"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Created string `json:"created"` + Datastoreid string `json:"datastoreid"` + Datastorename string `json:"datastorename"` + Datastorestate string `json:"datastorestate"` + Datastoretype string `json:"datastoretype"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Downloaddetails map[string]string `json:"downloaddetails"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Locationtype string `json:"locationtype"` + Name string `json:"name"` + Osdisplayname string `json:"osdisplayname"` + Ostypeid string `json:"ostypeid"` + Physicalsize int64 `json:"physicalsize"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Revertable bool `json:"revertable"` + Snapshottype string `json:"snapshottype"` + State string `json:"state"` + Status string `json:"status"` + Tags []Tags `json:"tags"` + Virtualsize int64 `json:"virtualsize"` + Volumeid string `json:"volumeid"` + Volumename string `json:"volumename"` + Volumetype string `json:"volumetype"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } func (r *Snapshot) UnmarshalJSON(b []byte) error { @@ -2069,31 +2214,38 @@ func (s *SnapshotService) RevertSnapshot(p *RevertSnapshotParams) (*RevertSnapsh } type RevertSnapshotResponse struct { - Account string `json:"account"` - Created string `json:"created"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Intervaltype string `json:"intervaltype"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Locationtype string `json:"locationtype"` - Name string `json:"name"` - Osdisplayname string `json:"osdisplayname"` - Ostypeid string `json:"ostypeid"` - Physicalsize int64 `json:"physicalsize"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Revertable bool `json:"revertable"` - Snapshottype string `json:"snapshottype"` - State string `json:"state"` - Tags []Tags `json:"tags"` - Virtualsize int64 `json:"virtualsize"` - Volumeid string `json:"volumeid"` - Volumename string `json:"volumename"` - Volumetype string `json:"volumetype"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Created string `json:"created"` + Datastoreid string `json:"datastoreid"` + Datastorename string `json:"datastorename"` + Datastorestate string `json:"datastorestate"` + Datastoretype string `json:"datastoretype"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Downloaddetails map[string]string `json:"downloaddetails"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Locationtype string `json:"locationtype"` + Name string `json:"name"` + Osdisplayname string `json:"osdisplayname"` + Ostypeid string `json:"ostypeid"` + Physicalsize int64 `json:"physicalsize"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Revertable bool `json:"revertable"` + Snapshottype string `json:"snapshottype"` + State string `json:"state"` + Status string `json:"status"` + Tags []Tags `json:"tags"` + Virtualsize int64 `json:"virtualsize"` + Volumeid string `json:"volumeid"` + Volumename string `json:"volumename"` + Volumetype string `json:"volumetype"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } func (r *RevertSnapshotResponse) UnmarshalJSON(b []byte) error { @@ -2273,6 +2425,7 @@ type RevertToVMSnapshotResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -2281,6 +2434,8 @@ type RevertToVMSnapshotResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2465,15 +2620,16 @@ func (s *SnapshotService) UpdateSnapshotPolicy(p *UpdateSnapshotPolicyParams) (* } type UpdateSnapshotPolicyResponse struct { - Fordisplay bool `json:"fordisplay"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Intervaltype int `json:"intervaltype"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxsnaps int `json:"maxsnaps"` - Schedule string `json:"schedule"` - Tags []Tags `json:"tags"` - Timezone string `json:"timezone"` - Volumeid string `json:"volumeid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Intervaltype int `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxsnaps int `json:"maxsnaps"` + Schedule string `json:"schedule"` + Tags []Tags `json:"tags"` + Timezone string `json:"timezone"` + Volumeid string `json:"volumeid"` + Zone []interface{} `json:"zone"` } diff --git a/cloudstack/StoragePoolService.go b/cloudstack/StoragePoolService.go index 80f79801..9637fcfd 100644 --- a/cloudstack/StoragePoolService.go +++ b/cloudstack/StoragePoolService.go @@ -121,6 +121,7 @@ type CancelStorageMaintenanceResponse struct { Hypervisor string `json:"hypervisor"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -226,6 +227,7 @@ type EnableStorageMaintenanceResponse struct { Hypervisor string `json:"hypervisor"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` + Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` diff --git a/cloudstack/SystemVMService.go b/cloudstack/SystemVMService.go index 40579301..45d08483 100644 --- a/cloudstack/SystemVMService.go +++ b/cloudstack/SystemVMService.go @@ -177,6 +177,8 @@ type ChangeServiceForSystemVmResponse struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` @@ -292,6 +294,8 @@ type DestroySystemVmResponse struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` @@ -656,6 +660,8 @@ type SystemVm struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` @@ -826,6 +832,8 @@ type MigrateSystemVmResponse struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` @@ -960,6 +968,8 @@ type RebootSystemVmResponse struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` @@ -1115,6 +1125,8 @@ type ScaleSystemVmResponse struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` @@ -1230,6 +1242,8 @@ type StartSystemVmResponse struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` @@ -1364,6 +1378,8 @@ type StopSystemVmResponse struct { Publicmacaddress string `json:"publicmacaddress"` Publicnetmask string `json:"publicnetmask"` Publicvlan []string `json:"publicvlan"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` State string `json:"state"` Systemvmtype string `json:"systemvmtype"` Templateid string `json:"templateid"` diff --git a/cloudstack/TemplateService.go b/cloudstack/TemplateService.go index 5362ee6b..71200e24 100644 --- a/cloudstack/TemplateService.go +++ b/cloudstack/TemplateService.go @@ -37,7 +37,7 @@ type TemplateServiceIface interface { ExtractTemplate(p *ExtractTemplateParams) (*ExtractTemplateResponse, error) NewExtractTemplateParams(id string, mode string) *ExtractTemplateParams GetUploadParamsForTemplate(p *GetUploadParamsForTemplateParams) (*GetUploadParamsForTemplateResponse, error) - NewGetUploadParamsForTemplateParams(displaytext string, format string, hypervisor string, name string, zoneid string) *GetUploadParamsForTemplateParams + NewGetUploadParamsForTemplateParams(format string, hypervisor string, name string, zoneid string) *GetUploadParamsForTemplateParams ListTemplatePermissions(p *ListTemplatePermissionsParams) (*ListTemplatePermissionsResponse, error) NewListTemplatePermissionsParams(id string) *ListTemplatePermissionsParams GetTemplatePermissionByID(id string, opts ...OptionFunc) (*TemplatePermission, int, error) @@ -285,6 +285,9 @@ func (p *CreateTemplateParams) 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["bits"]; found { vv := strconv.Itoa(v.(int)) u.Set("bits", vv) @@ -298,6 +301,9 @@ func (p *CreateTemplateParams) 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["isdynamicallyscalable"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("isdynamicallyscalable", vv) @@ -346,9 +352,27 @@ func (p *CreateTemplateParams) toURLValues() url.Values { if v, found := p.p["volumeid"]; found { u.Set("volumeid", v.(string)) } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } return u } +func (p *CreateTemplateParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *CreateTemplateParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + func (p *CreateTemplateParams) SetBits(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -394,6 +418,21 @@ func (p *CreateTemplateParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *CreateTemplateParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *CreateTemplateParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + func (p *CreateTemplateParams) SetIsdynamicallyscalable(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -604,6 +643,21 @@ func (p *CreateTemplateParams) GetVolumeid() (string, bool) { return value, ok } +func (p *CreateTemplateParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *CreateTemplateParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + // You should always use this function to get a new CreateTemplateParams instance, // as then you are sure you have configured all required params func (s *TemplateService) NewCreateTemplateParams(name string, ostypeid string) *CreateTemplateParams { @@ -1417,10 +1471,9 @@ func (p *GetUploadParamsForTemplateParams) GetZoneid() (string, bool) { // You should always use this function to get a new GetUploadParamsForTemplateParams instance, // as then you are sure you have configured all required params -func (s *TemplateService) NewGetUploadParamsForTemplateParams(displaytext string, format string, hypervisor string, name string, zoneid string) *GetUploadParamsForTemplateParams { +func (s *TemplateService) NewGetUploadParamsForTemplateParams(format string, hypervisor string, name string, zoneid string) *GetUploadParamsForTemplateParams { p := &GetUploadParamsForTemplateParams{} p.p = make(map[string]interface{}) - p.p["displaytext"] = displaytext p.p["format"] = format p.p["hypervisor"] = hypervisor p.p["name"] = name @@ -1587,10 +1640,17 @@ func (p *ListTemplatesParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("ids", vv) } + if v, found := p.p["imagestoreid"]; found { + u.Set("imagestoreid", v.(string)) + } if v, found := p.p["isrecursive"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("isrecursive", vv) } + if v, found := p.p["isvnf"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isvnf", vv) + } if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } @@ -1627,6 +1687,9 @@ func (p *ListTemplatesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showunique", vv) } + if v, found := p.p["storageid"]; found { + u.Set("storageid", v.(string)) + } if v, found := p.p["tags"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -1637,6 +1700,9 @@ func (p *ListTemplatesParams) toURLValues() url.Values { if v, found := p.p["templatefilter"]; found { u.Set("templatefilter", v.(string)) } + if v, found := p.p["templatetype"]; found { + u.Set("templatetype", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -1733,6 +1799,21 @@ func (p *ListTemplatesParams) GetIds() ([]string, bool) { return value, ok } +func (p *ListTemplatesParams) SetImagestoreid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["imagestoreid"] = v +} + +func (p *ListTemplatesParams) GetImagestoreid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["imagestoreid"].(string) + return value, ok +} + func (p *ListTemplatesParams) SetIsrecursive(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1748,6 +1829,21 @@ func (p *ListTemplatesParams) GetIsrecursive() (bool, bool) { return value, ok } +func (p *ListTemplatesParams) SetIsvnf(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isvnf"] = v +} + +func (p *ListTemplatesParams) GetIsvnf() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isvnf"].(bool) + return value, ok +} + func (p *ListTemplatesParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1898,6 +1994,21 @@ func (p *ListTemplatesParams) GetShowunique() (bool, bool) { return value, ok } +func (p *ListTemplatesParams) SetStorageid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageid"] = v +} + +func (p *ListTemplatesParams) GetStorageid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageid"].(string) + return value, ok +} + func (p *ListTemplatesParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1928,6 +2039,21 @@ func (p *ListTemplatesParams) GetTemplatefilter() (string, bool) { return value, ok } +func (p *ListTemplatesParams) SetTemplatetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["templatetype"] = v +} + +func (p *ListTemplatesParams) GetTemplatetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["templatetype"].(string) + return value, ok +} + func (p *ListTemplatesParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2406,6 +2532,9 @@ func (p *RegisterTemplateParams) toURLValues() url.Values { if v, found := p.p["templatetag"]; found { u.Set("templatetag", v.(string)) } + if v, found := p.p["templatetype"]; found { + u.Set("templatetype", v.(string)) + } if v, found := p.p["url"]; found { u.Set("url", v.(string)) } @@ -2749,6 +2878,21 @@ func (p *RegisterTemplateParams) GetTemplatetag() (string, bool) { return value, ok } +func (p *RegisterTemplateParams) SetTemplatetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["templatetype"] = v +} + +func (p *RegisterTemplateParams) GetTemplatetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["templatetype"].(string) + return value, ok +} + func (p *RegisterTemplateParams) SetUrl(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/TemplateService_mock.go b/cloudstack/TemplateService_mock.go index 6d4b686b..8921b95c 100644 --- a/cloudstack/TemplateService_mock.go +++ b/cloudstack/TemplateService_mock.go @@ -334,17 +334,17 @@ func (mr *MockTemplateServiceIfaceMockRecorder) NewExtractTemplateParams(id, mod } // NewGetUploadParamsForTemplateParams mocks base method. -func (m *MockTemplateServiceIface) NewGetUploadParamsForTemplateParams(displaytext, format, hypervisor, name, zoneid string) *GetUploadParamsForTemplateParams { +func (m *MockTemplateServiceIface) NewGetUploadParamsForTemplateParams(format, hypervisor, name, zoneid string) *GetUploadParamsForTemplateParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewGetUploadParamsForTemplateParams", displaytext, format, hypervisor, name, zoneid) + ret := m.ctrl.Call(m, "NewGetUploadParamsForTemplateParams", format, hypervisor, name, zoneid) ret0, _ := ret[0].(*GetUploadParamsForTemplateParams) return ret0 } // NewGetUploadParamsForTemplateParams indicates an expected call of NewGetUploadParamsForTemplateParams. -func (mr *MockTemplateServiceIfaceMockRecorder) NewGetUploadParamsForTemplateParams(displaytext, format, hypervisor, name, zoneid interface{}) *gomock.Call { +func (mr *MockTemplateServiceIfaceMockRecorder) NewGetUploadParamsForTemplateParams(format, hypervisor, name, zoneid interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewGetUploadParamsForTemplateParams", reflect.TypeOf((*MockTemplateServiceIface)(nil).NewGetUploadParamsForTemplateParams), displaytext, format, hypervisor, name, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewGetUploadParamsForTemplateParams", reflect.TypeOf((*MockTemplateServiceIface)(nil).NewGetUploadParamsForTemplateParams), format, hypervisor, name, zoneid) } // NewListTemplateDirectDownloadCertificatesParams mocks base method. diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 945c1ab0..eecc856d 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -312,6 +312,7 @@ type AddNicToVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -320,6 +321,8 @@ type AddNicToVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -615,6 +618,7 @@ type AssignVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -623,6 +627,8 @@ type AssignVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -942,6 +948,7 @@ type ChangeServiceForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -950,6 +957,8 @@ type ChangeServiceForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1233,6 +1242,9 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["overridediskofferingid"]; found { u.Set("overridediskofferingid", v.(string)) } + if v, found := p.p["password"]; found { + u.Set("password", v.(string)) + } if v, found := p.p["podid"]; found { u.Set("podid", v.(string)) } @@ -1888,6 +1900,21 @@ func (p *DeployVirtualMachineParams) GetOverridediskofferingid() (string, bool) return value, ok } +func (p *DeployVirtualMachineParams) SetPassword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["password"] = v +} + +func (p *DeployVirtualMachineParams) GetPassword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["password"].(string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetPodid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2220,6 +2247,7 @@ type DeployVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -2228,6 +2256,8 @@ type DeployVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2489,6 +2519,7 @@ type DestroyVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -2497,6 +2528,8 @@ type DestroyVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2776,6 +2809,10 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("isrecursive", vv) } + if v, found := p.p["isvnf"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isvnf", vv) + } if v, found := p.p["keypair"]; found { u.Set("keypair", v.(string)) } @@ -3122,6 +3159,21 @@ func (p *ListVirtualMachinesParams) GetIsrecursive() (bool, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetIsvnf(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isvnf"] = v +} + +func (p *ListVirtualMachinesParams) GetIsvnf() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isvnf"].(bool) + return value, ok +} + func (p *ListVirtualMachinesParams) SetKeypair(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3624,6 +3676,7 @@ type VirtualMachine struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -3632,6 +3685,8 @@ type VirtualMachine struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -3775,6 +3830,10 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("isrecursive", vv) } + if v, found := p.p["isvnf"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isvnf", vv) + } if v, found := p.p["keypair"]; found { u.Set("keypair", v.(string)) } @@ -4121,6 +4180,21 @@ func (p *ListVirtualMachinesMetricsParams) GetIsrecursive() (bool, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetIsvnf(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isvnf"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetIsvnf() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isvnf"].(bool) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetKeypair(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4631,6 +4705,7 @@ type VirtualMachinesMetric struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -4639,6 +4714,8 @@ type VirtualMachinesMetric struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -4917,6 +4994,7 @@ type MigrateVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -4925,6 +5003,8 @@ type MigrateVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -5222,6 +5302,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -5230,6 +5311,8 @@ type MigrateVirtualMachineWithVolumeResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -5491,6 +5574,7 @@ type RebootVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -5499,6 +5583,8 @@ type RebootVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -5702,6 +5788,7 @@ type RecoverVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -5710,6 +5797,8 @@ type RecoverVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -5952,6 +6041,7 @@ type RemoveNicFromVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -5960,6 +6050,8 @@ type RemoveNicFromVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -6045,6 +6137,9 @@ func (p *ResetPasswordForVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["password"]; found { + u.Set("password", v.(string)) + } return u } @@ -6063,6 +6158,21 @@ func (p *ResetPasswordForVirtualMachineParams) GetId() (string, bool) { return value, ok } +func (p *ResetPasswordForVirtualMachineParams) SetPassword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["password"] = v +} + +func (p *ResetPasswordForVirtualMachineParams) GetPassword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["password"].(string) + return value, ok +} + // You should always use this function to get a new ResetPasswordForVirtualMachineParams instance, // as then you are sure you have configured all required params func (s *VirtualMachineService) NewResetPasswordForVirtualMachineParams(id string) *ResetPasswordForVirtualMachineParams { @@ -6183,6 +6293,7 @@ type ResetPasswordForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -6191,6 +6302,8 @@ type ResetPasswordForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -6432,6 +6545,7 @@ type RestoreVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -6440,6 +6554,8 @@ type RestoreVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -6965,6 +7081,7 @@ type StartVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -6973,6 +7090,8 @@ type StartVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -7215,6 +7334,7 @@ type StopVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -7223,6 +7343,8 @@ type StopVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -7465,6 +7587,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -7473,6 +7596,8 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -8032,6 +8157,7 @@ type UpdateVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` Userdata string `json:"userdata"` Userdatadetails string `json:"userdatadetails"` Userdataid string `json:"userdataid"` @@ -8040,6 +8166,8 @@ type UpdateVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/ZoneService.go b/cloudstack/ZoneService.go index d23b7730..05b5bfb1 100644 --- a/cloudstack/ZoneService.go +++ b/cloudstack/ZoneService.go @@ -1165,6 +1165,10 @@ func (p *ListZonesParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["ids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("ids", vv) + } if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } @@ -1245,6 +1249,21 @@ func (p *ListZonesParams) GetId() (string, bool) { return value, ok } +func (p *ListZonesParams) SetIds(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ids"] = v +} + +func (p *ListZonesParams) GetIds() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ids"].([]string) + return value, ok +} + func (p *ListZonesParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1544,6 +1563,10 @@ func (p *ListZonesMetricsParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["ids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("ids", vv) + } if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } @@ -1624,6 +1647,21 @@ func (p *ListZonesMetricsParams) GetId() (string, bool) { return value, ok } +func (p *ListZonesMetricsParams) SetIds(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ids"] = v +} + +func (p *ListZonesMetricsParams) GetIds() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ids"].([]string) + return value, ok +} + func (p *ListZonesMetricsParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/generate/listApis.json b/generate/listApis.json index 48421657..df050bd4 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -22,11 +22,6 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -37,18 +32,23 @@ "name": "base64image", "type": "string" }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "resourceobjecttype" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.16.0.0" }, @@ -57,37 +57,6 @@ "isasync": true, "name": "createVPCOffering", "params": [ - { - "description": "services supported by the vpc offering", - "length": 255, - "name": "supportedservices", - "required": true, - "type": "list" - }, - { - "description": "the ID of the containing zone(s), null for public offerings", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" - }, - { - "description": "the name of the vpc offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", - "type": "string" - }, { "description": "the display text of the vpc offering, defaults to the 'name'", "length": 255, @@ -110,6 +79,22 @@ "required": false, "type": "map" }, + { + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "the 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, @@ -122,10 +107,18 @@ "description": "the ID of the containing domain(s), null for public offerings", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "list" }, + { + "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "length": 255, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", + "type": "string" + }, { "description": "the ID of the service offering for the VPC router appliance", "length": 255, @@ -133,56 +126,53 @@ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" + }, + { + "description": "services supported by the vpc offering", + "length": 255, + "name": "supportedservices", + "required": true, + "type": "list" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "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(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "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", @@ -193,13 +183,13 @@ "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the provider name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -213,9 +203,9 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the provider name", + "name": "name", + "type": "string" }, { "description": "uuid of the network provider", @@ -229,35 +219,19 @@ } ], "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" } ], "type": "list" }, + {}, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { @@ -265,19 +239,44 @@ "name": "domain", "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": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "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 name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -286,10 +285,11 @@ "type": "boolean" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" - } + }, + {} ] }, { @@ -298,16 +298,9 @@ "name": "createPod", "params": [ { - "description": "Allocation state of this Pod for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "the netmask for the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "netmask", + "name": "endip", "required": false, "type": "string" }, @@ -327,52 +320,48 @@ "type": "string" }, { - "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": "the name of the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "name", - "required": true, + "name": "gateway", + "required": false, "type": "string" }, { - "description": "the gateway for the Pod", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "gateway", + "name": "allocationstate", "required": false, "type": "string" + }, + { + "description": "the name of the Pod", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listPods,updatePod,createManagementNetworkIpRange", "response": [ - {}, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -381,69 +370,73 @@ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster name", + "name": "clustername", "type": "string" } ], "type": "list" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", "name": "vlanid", "type": "list" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, - {}, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, { "description": "the gateway of the Pod", "name": "gateway", @@ -454,15 +447,45 @@ "name": "jobid", "type": "string" }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, { "description": "the allocation state of the Pod", "name": "allocationstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" }, { "description": "the IP ranges for the Pod", @@ -474,13 +497,8 @@ "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { @@ -489,43 +507,25 @@ "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { "description": "the ending IP for the range", "name": "endip", "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" } ], "type": "list" }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - } + {}, + {} ] }, { @@ -534,9 +534,9 @@ "name": "ldapCreateAccount", "params": [ { - "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" }, @@ -547,6 +547,13 @@ "required": false, "type": "string" }, + { + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, { "description": "Creates the account under the specified role.", "length": 255, @@ -563,27 +570,19 @@ "type": "map" }, { - "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": "User UUID, required for adding account from external provisioning system", + "description": "Unique username.", "length": 255, - "name": "userid", - "required": false, + "name": "username", + "required": true, "type": "string" }, - { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" - }, { "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, @@ -592,419 +591,293 @@ "type": "string" }, { - "description": "Unique username.", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "timezone", + "name": "userid", "required": false, "type": "string" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ + {}, { "description": "the total secondary storage space (in GiB) owned by account", "name": "secondarystoragetotal", "type": "float" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "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 account", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "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": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "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 which can be stored by this account", - "name": "snapshotlimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { "description": "id of the Domain the account belongs to", "name": "domainid", "type": "string" }, + {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, - {}, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { @@ -1012,29 +885,156 @@ "name": "templateavailable", "type": "string" }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, { "description": "true if account is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the total number of 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", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "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 api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" } ], @@ -1054,7 +1054,18 @@ } ], "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", @@ -1064,17 +1075,6 @@ "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.6.0" @@ -1096,7 +1096,7 @@ "description": "Template ID.", "length": 255, "name": "id", - "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, @@ -1117,155 +1117,81 @@ "type": "uuid" } ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - { - "description": "the template 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", - "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "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": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, + {}, { - "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", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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 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" }, { @@ -1274,8 +1200,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], @@ -1287,24 +1213,59 @@ "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, { - "description": "the date this template was created", - "name": "created", + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { "description": "the name of the domain to which the template belongs", @@ -1312,14 +1273,19 @@ "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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": "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": "the userdata override policy with the userdata provided while deploying VM", @@ -1327,106 +1293,135 @@ "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 id of userdata linked to this template", - "name": "userdataid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "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": "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 name of userdata linked to this template", - "name": "userdataname", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "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 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", + "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": "the template ID", + "name": "id", + "type": "string" }, { "description": "true if this template is a featured template, false otherwise", @@ -1434,13 +1429,18 @@ "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "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" } ] @@ -1450,18 +1450,11 @@ "isasync": true, "name": "provisionCertificate", "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 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" }, @@ -1471,31 +1464,38 @@ "name": "reconnect", "required": false, "type": "boolean" + }, + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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" + }, + {} ], "since": "4.11.0" }, @@ -1514,15 +1514,20 @@ } ], "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" }, {}, @@ -1530,11 +1535,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -1544,127 +1544,128 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "the pod ID", + "description": "list vms by iso", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "details", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "hypervisor", + "name": "account", "required": false, "type": "string" }, { - "description": "the group ID", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "listall", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "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": "the host ID", + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "userdata", "required": false, - "type": "uuid" + "since": "4.18.0.0", + "type": "boolean" }, { "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, "name": "ids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "since": "4.4", "type": "list" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", "length": 255, - "name": "accumulate", + "name": "details", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, - "name": "isrecursive", + "name": "isvnf", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the availability zone ID", + "description": "list by the backup offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "backupofferingid", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "list vms by template", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "flag to display the resource icon for VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "showicon", + "name": "listall", "required": false, - "since": "4.16.0.0", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "since": "4.16.0.0", + "type": "boolean" }, { "description": "the security group ID", @@ -1676,66 +1677,69 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of AutoScaling VM Group", + "description": "", "length": 255, - "name": "autoscalevmgroupid", - "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "forvirtualnetwork", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the cluster ID", + "description": "the host ID", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list by the backup offering", + "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": "backupofferingid", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "name": "state", "required": false, - "since": "4.17", - "type": "uuid" + "type": "string" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "list vms by vpc", "length": 255, - "name": "haenable", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by template", + "description": "the ID of the virtual machine", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, @@ -1747,110 +1751,113 @@ "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the target hypervisor for the template", "length": 255, - "name": "displayvm", + "name": "hypervisor", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list vms by vpc", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "the cluster ID", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "the availability zone ID", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "userdata", + "name": "autoscalevmgroupid", + "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "since": "4.18.0", + "type": "uuid" }, { - "description": "list vms by iso", + "description": "List by keyword", "length": 255, - "name": "isoid", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by the service offering", + "description": "the pod ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "list by network id", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "list by network id", + "description": "list vms by affinity group", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list by the service offering", "length": 255, - "name": "tags", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "map" + "since": "4.4", + "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": "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": "state", + "name": "accumulate", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "haenable", "required": false, + "since": "4.15", "type": "boolean" } ], "related": "listVirtualMachinesMetrics", "response": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -1859,210 +1866,65 @@ "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - } - ], - "type": "set" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "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 total memory capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { @@ -2070,180 +1932,108 @@ "name": "osdisplayname", "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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 host for the virtual machine", - "name": "hostname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "disk write in MiB", - "name": "diskwrite", - "type": "string" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "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 availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -2252,47 +2042,27 @@ "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" } ], "type": "set" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "list of affinity groups associated with the virtual machine", @@ -2304,8 +2074,8 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -2319,61 +2089,51 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "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", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "disk read in MiB", - "name": "diskread", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "network write in MiB", - "name": "networkwrite", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -2382,305 +2142,513 @@ "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", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - {}, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the 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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "disk read in MiB", + "name": "diskread", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "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", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the security group", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the 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": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the 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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -2689,33 +2657,38 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], @@ -2726,31 +2699,6 @@ "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -2760,139 +2708,223 @@ "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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" } ], "type": "set" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "disk write in MiB", + "name": "diskwrite", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "network write in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, { "description": "network read in MiB", "name": "networkread", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + {}, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" } ] }, @@ -2902,63 +2934,63 @@ "name": "listHosts", "params": [ { - "description": "the id of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the state of the host", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "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", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "hahost", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the Pod ID for the host", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "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": "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 host type", + "description": "", "length": 255, - "name": "type", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list hosts for which out-of-band management is enabled", @@ -2968,31 +3000,23 @@ "type": "boolean" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "the host type", "length": 255, - "name": "resourcestate", + "name": "type", "required": false, "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "lists hosts existing in particular cluster", + "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": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "resourcestate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the state of the host", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, @@ -3004,125 +3028,103 @@ "type": "string" }, { - "description": "", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "page", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Zone ID for the host", + "description": "the id of the host", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "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": "hypervisor", + "name": "outofbandmanagementpowerstate", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "response": [ { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "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": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "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 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 after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, + {}, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the date and time the host was last pinged", @@ -3130,44 +3132,39 @@ "type": "date" }, { - "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": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the 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 amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", @@ -3175,28 +3172,13 @@ "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "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 cluster name of the host", + "name": "clustername", "type": "string" }, { @@ -3204,25 +3186,24 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "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", @@ -3233,61 +3214,61 @@ "name": "maxresolutionx", "type": "long" }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "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", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { "description": "Video RAM for this vGPU type", "name": "videoram", "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { "description": "the name of the host", @@ -3295,44 +3276,64 @@ "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 OS category name of the host", - "name": "oscategoryname", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "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 amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { "description": "the host HA information information", @@ -3340,43 +3341,63 @@ "type": "hostharesponse" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { @@ -3384,15 +3405,31 @@ "name": "podname", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "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": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" } ] }, @@ -3401,32 +3438,222 @@ "isasync": false, "name": "deleteStoragePool", "params": [ + { + "description": "Storage pool id", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", + "required": true, + "type": "uuid" + }, { "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", "length": 255, "name": "forced", "required": false, "type": "boolean" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "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": "List storage pools compatible with a vSphere storage policy", + "isasync": false, + "name": "listVsphereStoragePolicyCompatiblePools", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Storage pool id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" + }, + { + "description": "ID of the storage policy", + "length": 255, + "name": "policyid", + "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "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 name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + {}, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -3435,11 +3662,15 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, - {} + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + } ] }, { @@ -3462,6 +3693,13 @@ "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", @@ -3471,14 +3709,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {} + } ], "since": "4.17.0.0" }, @@ -3488,11 +3719,19 @@ "name": "updateStoragePool", "params": [ { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "the URL of the storage pool", "length": 255, - "name": "capacityiops", + "name": "url", "required": false, - "type": "long" + "since": "4.19.0", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" }, { "description": "the Id of the storage pool", @@ -3503,18 +3742,19 @@ "type": "uuid" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "capacitybytes", + "name": "enabled", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "comma-separated list of tags for the storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "tags", + "name": "details", "required": false, - "type": "list" + "since": "4.19.0", + "type": "map" }, { "description": "Change the name of the storage pool", @@ -3526,60 +3766,73 @@ "type": "string" }, { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "comma-separated list of tags for the storage pool", "length": 255, - "name": "enabled", + "name": "tags", "required": false, - "type": "boolean" + "type": "list" + }, + { + "description": "bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "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": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { "description": "the storage pool path", @@ -3587,29 +3840,29 @@ "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "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 total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { "description": "the date and time the storage pool was created", @@ -3617,18 +3870,18 @@ "type": "date" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -3637,8 +3890,13 @@ "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { @@ -3647,35 +3905,36 @@ "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the 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" } ], "since": "3.0.0" @@ -3685,14 +3944,6 @@ "isasync": true, "name": "rebootSystemVm", "params": [ - { - "description": "Force reboot the system VM (System VM is Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, { "description": "The ID of the system virtual machine", "length": 255, @@ -3700,94 +3951,122 @@ "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "required": true, "type": "uuid" + }, + { + "description": "Force reboot the system VM (System VM is Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" } ], "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ - {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, + {}, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "guest vlan range", + "name": "guestvlan", "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": "the public IP address for the system VM", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the Zone ID for the system VM", "name": "zoneid", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" + }, + { + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, + { + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, { "description": "the private netmask for the system VM", "name": "privatenetmask", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -3796,59 +4075,58 @@ "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "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 network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "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 agent state of the system VM", - "name": "agentstate", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the state of the system VM", + "name": "state", "type": "string" }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, { "description": "the public netmask for the system VM", "name": "publicnetmask", "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" }, { @@ -3857,43 +4135,33 @@ "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "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 ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "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 control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { @@ -3902,10 +4170,11 @@ "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" - } + }, + {} ] }, { @@ -3914,31 +4183,30 @@ "name": "listTungstenFabricTag", "params": [ { - "description": "", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "pagesize", + "name": "networkuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "tthe uuid of Tungsten-Fabric nic", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "nicuuid", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric vm", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "vmuuid", + "name": "nicuuid", "required": false, "type": "string" }, @@ -3950,58 +4218,63 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "networkuuid", + "name": "policyuuid", "required": false, "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "page", + "name": "vmuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "", "length": 255, - "name": "policyuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the ID of zone", "length": 255, - "name": "applicationpolicysetuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createTungstenFabricTag,applyTungstenFabricTag,removeTungstenFabricTag", "response": [ { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, - {}, { "description": "list Tungsten-Fabric vm", "name": "vm", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "list Tungsten-Fabric policy", @@ -4009,36 +4282,32 @@ "type": "list" }, { - "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": "list Tungsten-Fabric network", "name": "network", "type": "list" }, + {}, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } + {} ] }, { @@ -4046,20 +4315,6 @@ "isasync": false, "name": "importLdapUsers", "params": [ - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -4070,7 +4325,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -4089,12 +4344,18 @@ "type": "integer" }, { - "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": "details for account used to store specific parameters", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "accountdetails", "required": false, - "type": "uuid" + "type": "map" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "Creates the account under the specified role.", @@ -4105,32 +4366,69 @@ "type": "uuid" }, { - "description": "details for account used to store specific parameters", + "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": "accountdetails", + "name": "group", "required": false, - "type": "map" + "type": "string" }, { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "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": "group", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", "required": false, "type": "string" } ], "related": "searchLdap,listLdapUsers", "response": [ + { + "description": "The user's firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "The user's email", + "name": "email", + "type": "string" + }, + { + "description": "The user's username", + "name": "username", + "type": "string" + }, + { + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "The user's lastname", "name": "lastname", "type": "string" }, - {}, { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's domain", + "name": "domain", "type": "string" }, { @@ -4138,14 +4436,53 @@ "name": "principal", "type": "string" }, + {} + ], + "since": "4.3.0" + }, + { + "description": "Moves a domain and its children to a new parent domain.", + "isasync": false, + "name": "moveDomain", + "params": [ + { + "description": "The ID of the new parent domain of the domain to be moved.", + "length": 255, + "name": "parentdomainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the domain to be moved.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": true, + "type": "uuid" + } + ], + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "response": [ + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "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 total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + {}, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { @@ -4154,32 +4491,263 @@ "type": "integer" }, { - "description": "The user's email", - "name": "email", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the path of the domain", + "name": "path", + "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": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + {} ], - "since": "4.3.0" + "since": "4.19.0.0" }, { "description": "List dedicated zones.", "isasync": false, "name": "listDedicatedZones", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -4198,18 +4766,10 @@ "required": false, "type": "string" }, - { - "description": "the ID of the Zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -4220,21 +4780,14 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "dedicateZone", "response": [ {}, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { @@ -4243,20 +4796,21 @@ "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 Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the Name of the Zone", "name": "zonename", @@ -4267,10 +4821,9 @@ "name": "zoneid", "type": "string" }, - {}, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" } ] @@ -4281,9 +4834,33 @@ "name": "listNetworks", "params": [ { - "description": "flag to display the resource icon for networks", + "description": "list networks by ID", "length": 255, - "name": "showicon", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displaynetwork", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list networks by network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "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" }, @@ -4295,35 +4872,33 @@ "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 display flag; only ROOT admin is eligible to pass this parameter", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "displaynetwork", + "name": "type", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list networks by physical network id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the zone ID of the network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list networks by restartRequired", @@ -4333,76 +4908,84 @@ "type": "boolean" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "list networks available for VM deployment", "length": 255, - "name": "type", + "name": "canusefordeploy", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List networks by associated networks. Only available if create a Shared network.", + "description": "List networks by VPC", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "since": "4.17.0", "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": "true if need to list only networks which support specifying IP ranges", + "description": "the zone ID of the network", "length": 255, - "name": "specifyipranges", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the network belongs to VPC", + "description": "list networks by physical network id", "length": 255, - "name": "forvpc", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID or VID of the network", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vlan", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "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).", + "length": 255, + "name": "networkfilter", "required": false, "since": "4.17.0", "type": "string" }, { - "description": "list networks by ID", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "acltype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "keyword", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "type of the traffic", "length": 255, - "name": "account", + "name": "traffictype", "required": false, "type": "string" }, @@ -4414,103 +4997,143 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the network belongs to VPC", "length": 255, - "name": "isrecursive", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID or VID of the network", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "vlan", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "string" }, { - "description": "list networks available for VM deployment", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "canusefordeploy", + "name": "specifyipranges", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "List networks by VPC", + "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": "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 resources by tags (key/value pairs)", "length": 255, - "name": "networkfilter", + "name": "tags", "required": false, - "since": "4.17.0", - "type": "string" + "type": "map" }, { - "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" + } + ], + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "list networks by network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", - "length": 255, - "name": "acltype", - "required": false, + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "list networks supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "type of the traffic", - "length": 255, - "name": "traffictype", - "required": false, + "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" - } - ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { @@ -4518,43 +5141,43 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project 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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -4563,21 +5186,26 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -4586,38 +5214,58 @@ "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { @@ -4626,8 +5274,8 @@ "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -4636,77 +5284,162 @@ "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "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 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": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { "description": "the list of services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -4719,10 +5452,20 @@ "name": "name", "type": "string" }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" } ], "type": "list" @@ -4737,89 +5480,55 @@ "type": "boolean" }, { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, { "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", "name": "zonesnetworkspans", "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", + "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": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { @@ -4828,14 +5537,9 @@ "type": "set" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { "description": "the id of the network", @@ -4843,203 +5547,61 @@ "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": "Lists the pools of elastistor", + "isasync": false, + "name": "listElastistorPool", + "params": [ { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, + "description": "the ID of the Pool", + "length": 255, + "name": "id", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - {}, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the current available space of the pool", + "name": "size", "type": "long" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the network", + "description": "the name of the storage pool", "name": "name", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "default gateway of the pool", + "name": "gateway", "type": "string" }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - } - ] - }, - { - "description": "Lists the pools of elastistor", - "isasync": false, - "name": "listElastistorPool", - "params": [ - { - "description": "the ID of the Pool", - "length": 255, - "name": "id", - "required": false, - "type": "long" - } - ], - "related": "", - "response": [ {}, - { - "description": "the state of the storage pool", - "name": "state", - "type": "string" - }, { "description": "available iops of the pool", "name": "maxiops", "type": "long" }, - { - "description": "the current available space of the pool", - "name": "size", - "type": "long" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the storage pool", + "name": "state", "type": "string" }, { @@ -5052,11 +5614,7 @@ "name": "controllerid", "type": "string" }, - { - "description": "default gateway of the pool", - "name": "gateway", - "type": "string" - } + {} ] }, { @@ -5079,23 +5637,23 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.17" }, @@ -5104,6 +5662,13 @@ "isasync": true, "name": "updatePodManagementNetworkIpRange", "params": [ + { + "description": "The new starting IP address.", + "length": 255, + "name": "newstartip", + "required": false, + "type": "string" + }, { "description": "The new ending IP address.", "length": 255, @@ -5112,9 +5677,9 @@ "type": "string" }, { - "description": "The current ending IP address.", + "description": "The current starting IP address.", "length": 255, - "name": "currentendip", + "name": "currentstartip", "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, "type": "string" @@ -5128,43 +5693,36 @@ "type": "uuid" }, { - "description": "The current starting IP address.", + "description": "The current ending IP address.", "length": 255, - "name": "currentstartip", + "name": "currentendip", "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, "type": "string" - }, - { - "description": "The new starting IP address.", - "length": 255, - "name": "newstartip", - "required": false, - "type": "string" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.16.0.0" @@ -5174,6 +5732,14 @@ "isasync": false, "name": "listTungstenFabricLBHealthMonitor", "params": [ + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -5194,42 +5760,28 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "the ID of lb rule", - "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "the health monitor ID", + "name": "id", + "type": "long" }, - {}, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the health monitor timeout", - "name": "timeout", + "description": "the health monitor retry", + "name": "retry", "type": "int" }, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { @@ -5238,18 +5790,18 @@ "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the health monitor url path", + "name": "urlpath", + "type": "string" }, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { @@ -5257,27 +5809,33 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the health monitor interval", + "name": "interval", + "type": "int" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, - {}, { "description": "the health monitor type", "name": "type", "type": "string" }, - { - "description": "the health monitor retry", - "name": "retry", - "type": "int" - } + {} ] }, { @@ -5293,14 +5851,6 @@ "since": "4.4", "type": "string" }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the ID of the firewall rule", "length": 255, @@ -5308,51 +5858,28 @@ "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, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ - {}, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, { "description": "the public ip address id for the firewall rule", "name": "ipaddressid", "type": "string" }, { - "description": "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 list of resource tags associated with the rule", "name": "tags", @@ -5367,11 +5894,6 @@ "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", @@ -5383,23 +5905,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -5416,14 +5943,19 @@ "type": "integer" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" }, { "description": "the traffic type for the firewall rule", @@ -5431,13 +5963,13 @@ "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { @@ -5446,11 +5978,37 @@ "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {} + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + } ], "since": "4.4" }, @@ -5461,6 +6019,11 @@ "params": [], "related": "", "response": [ + { + "description": "is quota service enabled", + "name": "isenabled", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -5472,90 +6035,49 @@ "name": "jobid", "type": "string" }, - { - "description": "is quota service enabled", - "name": "isenabled", - "type": "boolean" - }, {} ], "since": "4.7.0" }, { - "description": "Lists all quota email templates", + "description": "Deletes the registered OAuth provider", "isasync": false, - "name": "quotaEmailTemplateList", + "name": "deleteOauthProvider", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "description": "id of the OAuth provider to be deleted", "length": 255, - "name": "templatetype", - "required": false, - "type": "string" + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "required": true, + "type": "uuid" } ], - "related": "", "response": [ {}, { - "description": "The quota email template content", - "name": "templatebody", - "type": "string" - }, - {}, - { - "description": "Template type", - "name": "templatetype", - "type": "string" - }, - { - "description": "Last date/time when template was updated", - "name": "last_updated", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The quota email template locale", - "name": "locale", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The quota email template subject", - "name": "templatesubject", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.7.0" + "since": "4.19.0" }, { "description": "Deletes account from the project", @@ -5563,27 +6085,33 @@ "name": "deleteAccountFromProject", "params": [ { - "description": "ID of the project to remove the account from", + "description": "name of the account to be removed from the project", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "account", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "name of the account to be removed from the project", + "description": "ID of the project to remove the account from", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, - "type": "string" + "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", @@ -5594,13 +6122,7 @@ "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ], "since": "3.0.0" }, @@ -5620,23 +6142,23 @@ ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Hypervisor name", "name": "name", "type": "string" - } + }, + {} ] }, { @@ -5644,13 +6166,6 @@ "isasync": true, "name": "updateGuestOs", "params": [ - { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, - "type": "string" - }, { "description": "Map of (key/value pairs)", "length": 255, @@ -5665,16 +6180,45 @@ "related": "listOsTypes,addGuestOs,updateGuestOs", "required": true, "type": "uuid" + }, + { + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" + }, + { + "description": "Unique display name for Guest OS", + "length": 255, + "name": "osdisplayname", + "required": true, + "type": "string" } ], "related": "listOsTypes,addGuestOs", "response": [ { - "description": "is the guest OS user defined", - "name": "isuserdefined", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the OS type", + "name": "name", + "type": "string" + }, + { + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -5686,30 +6230,20 @@ "type": "string" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, + {}, { "description": "the name/description of the OS type", "name": "description", "type": "string" }, { - "description": "the name of the OS type", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" } ], "since": "4.4.0" @@ -5720,11 +6254,11 @@ "name": "listGuestVlans", "params": [ { - "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": "list guest vlan by vnet", @@ -5741,18 +6275,25 @@ "type": "long" }, { - "description": "list guest vlan by physical network", + "description": "list guest vlan by zone", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list guest vlan by zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list guest vlan by physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, @@ -5769,20 +6310,18 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "limits search results to allocated guest vlan. false by default.", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" } ], "related": "", "response": [ { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { @@ -5796,44 +6335,33 @@ "type": "integer" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" - }, - { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" - }, - { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "the project id of the guest VLAN range", - "name": "projectid", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -5842,31 +6370,37 @@ "type": "long" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" }, + {}, { "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 list of networks who use this guest VLAN", + "name": "network", + "type": "list" }, - {}, { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" + }, + { + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" + }, + {} ], "since": "4.17.0" }, @@ -5876,11 +6410,18 @@ "name": "updateResourceLimit", "params": [ { - "description": " Maximum resource limit.", + "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "max", + "name": "resourcetype", + "required": true, + "type": "integer" + }, + { + "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, - "type": "long" + "type": "string" }, { "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", @@ -5891,11 +6432,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", @@ -5904,30 +6445,33 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" - }, - { - "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "integer" } ], "related": "listResourceLimits", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", "name": "resourcetype", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "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" }, { @@ -5935,9 +6479,11 @@ "name": "resourcetypename", "type": "string" }, + {}, + {}, { - "description": "the account of the resource limit", - "name": "account", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { @@ -5945,27 +6491,15 @@ "name": "domainid", "type": "string" }, - {}, { "description": "the domain name of the resource limit", "name": "domain", "type": "string" }, - {}, - { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" - }, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -5984,28 +6518,28 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ] }, { @@ -6014,53 +6548,53 @@ "name": "listHostsMetrics", "params": [ { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "details", + "name": "hahost", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "hypervisor", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host type", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the name of the host", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "the Zone ID for the host", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the Pod ID for the host", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, @@ -6072,118 +6606,88 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "keyword", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the Pod ID for the host", "length": 255, - "name": "page", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "lists hosts existing in particular cluster", + "description": "the host type", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the id of the host", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "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": "resourcestate", + "name": "outofbandmanagementpowerstate", "required": false, "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "List by keyword", "length": 255, - "name": "hahost", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "the id of the host", "length": 255, - "name": "outofbandmanagementenabled", + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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,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", + "name": "resourcestate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "memory usage disable threshold exceeded", "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "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": "network read in GiB", - "name": "networkread", - "type": "string" - }, - { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", @@ -6191,49 +6695,29 @@ "type": "boolean" }, { - "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 Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, { "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 memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "instances on the host", + "name": "instances", + "type": "string" }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", @@ -6241,29 +6725,38 @@ "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "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", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" }, - {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "events available for the host", + "name": "events", "type": "string" }, { @@ -6272,18 +6765,8 @@ "type": "powerstate" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the host version", - "name": "version", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { @@ -6292,170 +6775,115 @@ "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the total memory used in GiB", - "name": "memoryusedgb", - "type": "string" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "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 amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, + {}, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "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 total memory capacity in GiB", - "name": "memorytotalgb", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "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 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": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, - {}, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { "description": "GPU cards present in the host", @@ -6466,23 +6894,28 @@ "name": "vgpu", "response": [ { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "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", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -6491,18 +6924,13 @@ "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" } ], @@ -6517,9 +6945,9 @@ "type": "list" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { "description": "cpu usage notification threshold exceeded", @@ -6527,44 +6955,79 @@ "type": "boolean" }, { - "description": "instances on the host", - "name": "instances", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "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": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "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 CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "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", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the admin that annotated this host", @@ -6572,23 +7035,59 @@ "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": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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 amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "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 incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + {}, + { + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { @@ -6597,9 +7096,54 @@ "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "system vm instances on the host", + "name": "systeminstances", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" } ], "since": "4.9.3" @@ -6621,15 +7165,15 @@ "related": "", "response": [ { - "description": "key", - "name": "key", + "description": "crt", + "name": "crt", "type": "string" }, {}, {}, { - "description": "crt", - "name": "crt", + "description": "chain", + "name": "chain", "type": "string" }, { @@ -6638,13 +7182,13 @@ "type": "integer" }, { - "description": "chain", - "name": "chain", + "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": "key", + "name": "key", "type": "string" } ] @@ -6664,65 +7208,20 @@ } ], "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": "Cancels a triggered shutdown", - "isasync": false, - "name": "cancelShutdown", - "params": [ - { - "description": "the uuid of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": true, - "type": "uuid" - } - ], - "related": "prepareForShutdown,readyForShutdown,triggerShutdown", - "response": [ - { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" - }, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "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" }, { @@ -6730,14 +7229,8 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - } - ], - "since": "4.19.0" + {} + ] }, { "description": "Lists affinity groups", @@ -6745,109 +7238,115 @@ "name": "listAffinityGroups", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "lists affinity groups by type", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "lists affinity groups by name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "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,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", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "lists affinity groups by type", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "type", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list the affinity group by the ID provided", "length": 255, - "name": "account", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "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": "list the affinity group by the ID provided", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "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,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "", + "description": "lists affinity groups by name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" } ], "related": "createAffinityGroup", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "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 type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -6855,15 +7354,25 @@ "name": "account", "type": "string" }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, {}, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, { "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6871,33 +7380,68 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "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": "Cancels a triggered shutdown", + "isasync": false, + "name": "cancelShutdown", + "params": [ + { + "description": "the uuid of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown,readyForShutdown,triggerShutdown", + "response": [ + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" } - ] + ], + "since": "4.19.0" }, { "description": "Register a public key in a keypair under a certain name", @@ -6905,24 +7449,18 @@ "name": "registerSSHKeyPair", "params": [ { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "an optional domainId for the ssh key. 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" - }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "an optional project for the ssh key", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -6934,60 +7472,62 @@ "type": "string" }, { - "description": "an optional project for the ssh key", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listSSHKeyPairs", "response": [ { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "Name of the keypair", + "name": "name", "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": "the domain name of the keypair owner", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, + {}, { "description": "ID of the ssh keypair", "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "Name of the keypair", - "name": "name", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { @@ -6995,11 +7535,15 @@ "name": "fingerprint", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project name of the keypair owner", + "name": "project", + "type": "string" } ] }, @@ -7019,22 +7563,22 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -7047,14 +7591,6 @@ "isasync": true, "name": "startRollingMaintenance", "params": [ - { - "description": "the IDs of the clusters to start maintenance on", - "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "list" - }, { "description": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, @@ -7063,10 +7599,10 @@ "type": "integer" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "the IDs of the pods to start maintenance on", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "podids", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "list" }, @@ -7074,110 +7610,118 @@ "description": "the IDs of the hosts to start maintenance on", "length": 255, "name": "hostids", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, "type": "list" }, { - "description": "if rolling mechanism should continue in case of an error", + "description": "the IDs of the clusters to start maintenance on", "length": 255, - "name": "forced", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the IDs of the pods to start maintenance on", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "podids", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "payload", + "required": false, + "type": "string" + }, + { + "description": "the IDs of the zones to start maintenance on", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" }, { - "description": "the command to execute while hosts are on maintenance", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "payload", + "name": "forced", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ - {}, - { - "description": "indicates if the rolling maintenance operation was successful", - "name": "success", - "type": "boolean" - }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the hosts skipped", + "name": "hostsskipped", + "response": [ + { + "description": "the name of the skipped host", + "name": "hostname", + "type": "string" + }, + { + "description": "the reason to skip the host", + "name": "reason", + "type": "string" + }, + { + "description": "the ID of the skipped host", + "name": "hostid", + "type": "string" + } + ], + "type": "list" }, { - "description": "in case of failure, details are displayed", - "name": "details", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the hosts updated", "name": "hostsupdated", "response": [ - { - "description": "the ID of the updated host", - "name": "hostid", - "type": "string" - }, { "description": "the name of the updated host", "name": "hostname", "type": "string" }, - { - "description": "end date of the update on the host", - "name": "enddate", - "type": "string" - }, { "description": "output of the maintenance script on the host", "name": "output", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the hosts skipped", - "name": "hostsskipped", - "response": [ - { - "description": "the ID of the skipped host", + "description": "the ID of the updated host", "name": "hostid", "type": "string" }, { - "description": "the reason to skip the host", - "name": "reason", + "description": "end date of the update on the host", + "name": "enddate", "type": "string" }, { - "description": "the name of the skipped host", - "name": "hostname", + "description": "start date of the update on the host", + "name": "startdate", "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "in case of failure, details are displayed", + "name": "details", + "type": "string" + }, + {}, + {}, + { + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -7186,6 +7730,20 @@ "isasync": false, "name": "listTungstenFabricApplicationPolicySet", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, @@ -7207,65 +7765,51 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "createTungstenFabricApplicationPolicySet", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {}, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "list Tungsten-Fabric tag", "name": "tag", "type": "list" }, - {}, { "description": "Tungsten-Fabric application policy uuid", "name": "uuid", "type": "string" - }, - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" } ] }, @@ -7283,19 +7827,19 @@ "type": "string" }, { - "description": "Name of the network ACL list", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the network ACL", + "description": "Name of the network ACL list", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "Description of the network ACL list", @@ -7305,19 +7849,20 @@ "type": "string" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "the ID of the network ACL", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" } ], "response": [ + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -7325,16 +7870,15 @@ "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.4" @@ -7344,13 +7888,6 @@ "isasync": false, "name": "reserveIpAddress", "params": [ - { - "description": "the account to reserve with this IP address", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the ID of the public IP address to reserve", "length": 255, @@ -7367,6 +7904,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the domain to reserve with this IP address", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, { "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, @@ -7375,43 +7920,48 @@ "type": "boolean" }, { - "description": "the ID of the domain to reserve with this IP address", + "description": "the account to reserve with this IP address", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "the list of resource tags associated with ip address", "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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -7419,6 +7969,11 @@ "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", @@ -7430,113 +7985,111 @@ "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", "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" } ], "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, - {}, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" }, - {}, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "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": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { @@ -7544,50 +8097,46 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", - "type": "string" - }, { "description": "the name of the Network associated with the IP address", "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, + {}, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" }, { "description": "is public ip for display to the regular user", @@ -7595,14 +8144,9 @@ "type": "boolean" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the project id of the ipaddress", @@ -7610,18 +8154,18 @@ "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" } ], @@ -7636,7 +8180,7 @@ "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", "length": 255, "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, @@ -7644,174 +8188,41 @@ "description": "Virtual Machine ID", "length": 255, "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,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,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,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,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the 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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -7819,39 +8230,34 @@ "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { "description": "Id of the vm to which the nic belongs", @@ -7859,63 +8265,68 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -7924,18 +8335,23 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -7944,14 +8360,9 @@ "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the isolated private VLAN if available", @@ -7959,102 +8370,77 @@ "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the project id of the vm", - "name": "projectid", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, {}, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -8062,27 +8448,94 @@ "name": "securitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -8090,28 +8543,28 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -8120,36 +8573,36 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -8158,50 +8611,30 @@ "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 protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "type": "set" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -8210,8 +8643,8 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -8225,37 +8658,32 @@ "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -8264,113 +8692,56 @@ "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "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", @@ -8385,23 +8756,28 @@ "description": "the ID of the security group", "name": "id", "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -8409,188 +8785,89 @@ "name": "publicip", "type": "string" }, + {}, { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "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 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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", "name": "diskofferingname", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, { "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 id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the 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", - "type": "string" - }, - { - "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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" }, { @@ -8601,40 +8878,271 @@ ], "type": "set" }, - {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "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", + "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", + "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 ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "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", + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -8642,19 +9150,80 @@ "name": "diskkbsread", "type": "long" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + {}, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, { "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" } ], @@ -8673,11 +9242,12 @@ "type": "string" }, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the IDs of the events", "length": 255, - "name": "enddate", + "name": "ids", + "related": "listEvents", "required": false, - "type": "date" + "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\")", @@ -8687,36 +9257,35 @@ "type": "date" }, { - "description": "the IDs of the events", + "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": "ids", - "related": "listEvents", + "name": "enddate", "required": false, - "type": "list" + "type": "date" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -8735,28 +9304,28 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "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" + } ] }, { @@ -8767,22 +9336,14 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "ucs manager id", - "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -8792,45 +9353,53 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "ucs manager id", + "length": 255, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" } ], "related": "associateUcsProfileToBlade", "response": [ - {}, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, { - "description": "ucs blade id", - "name": "id", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, + {}, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "the UUID of the latest async job acting on 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": "ucs blade id", + "name": "id", "type": "string" }, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" } ] @@ -8850,11 +9419,6 @@ ], "response": [ {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -8870,6 +9434,11 @@ "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {} ] }, @@ -8888,23 +9457,23 @@ ], "related": "getVolumeiScsiName", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -8916,7 +9485,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,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, @@ -8930,23 +9499,23 @@ } ], "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", @@ -8959,14 +9528,6 @@ "isasync": false, "name": "updateHost", "params": [ - { - "description": "Add an annotation to this host", - "length": 255, - "name": "annotation", - "required": false, - "since": "4.11", - "type": "string" - }, { "description": "list of tags to be added to the host", "length": 255, @@ -8975,11 +9536,11 @@ "type": "list" }, { - "description": "the id of Os category to update the host with", + "description": "the ID of the host to update", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "required": true, "type": "uuid" }, { @@ -8989,6 +9550,14 @@ "required": false, "type": "string" }, + { + "description": "the id of Os category to update the host with", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "type": "uuid" + }, { "description": "Change the name of host", "length": 255, @@ -9005,139 +9574,123 @@ "type": "string" }, { - "description": "the ID of the host to update", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", - "required": true, - "type": "uuid" + "name": "istagarule", + "required": false, + "type": "boolean" + }, + { + "description": "Add an annotation to this host", + "length": 255, + "name": "annotation", + "required": false, + "since": "4.11", + "type": "string" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "response": [ { - "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 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 ID of the host", - "name": "id", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently 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": "events available for the host", - "name": "events", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, + {}, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "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 memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the resource state of the host", + "name": "resourcestate", + "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" }, { @@ -9146,14 +9699,19 @@ "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { "description": "the amount of the host's CPU currently allocated", @@ -9161,148 +9719,79 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, { "description": "true if the host is disconnected. False otherwise.", "name": "disconnected", "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "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": "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": "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 type", + "name": "type", + "type": "type" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "true if 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 management server ID of the host", @@ -9310,45 +9799,63 @@ "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { "description": "the date and time the host was last pinged", "name": "lastpinged", "type": "date" }, - {}, + { + "description": "the host version", + "name": "version", + "type": "string" + }, { "description": "true if the host has capability to support UEFI boot", "name": "ueficapability", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 hypervisor", + "name": "hypervisor", + "type": "string" }, { - "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 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 amount of the host's CPU currently used", - "name": "cpuused", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { @@ -9357,9 +9864,68 @@ "type": "double" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { "description": "the CPU speed of the host", @@ -9367,18 +9933,33 @@ "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" } ] @@ -9388,6 +9969,13 @@ "isasync": true, "name": "createEgressFirewallRule", "params": [ + { + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, { "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, @@ -9396,11 +9984,12 @@ "type": "list" }, { - "description": "type of firewallrule: system/user", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "type", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "error code for this icmp message", @@ -9409,6 +9998,13 @@ "required": false, "type": "integer" }, + { + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, { "description": "type of the icmp message being sent", "length": 255, @@ -9424,21 +10020,6 @@ "required": true, "type": "uuid" }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "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, @@ -9447,16 +10028,16 @@ "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "type of firewallrule: system/user", "length": 255, - "name": "cidrlist", + "name": "type", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "the starting port of firewall rule", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" } @@ -9464,47 +10045,69 @@ "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "the public ip address for the firewall rule", "name": "ipaddress", "type": "string" }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + {}, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -9513,37 +10116,42 @@ "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 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": "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", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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", + "type": "string" }, { "description": "the network id of the firewall rule", @@ -9551,55 +10159,28 @@ "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 state of the rule", - "name": "state", - "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 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": "type of the icmp message being sent", - "name": "icmptype", + "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": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { - "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 state of the rule", + "name": "state", "type": "string" } ] @@ -9610,71 +10191,71 @@ "name": "listVPCOfferings", "params": [ { - "description": "list VPC offerings supporting certain services", + "description": "id of zone VPC offering is associated with", "length": 255, - "name": "supportedservices", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "list" + "since": "4.13", + "type": "uuid" }, { - "description": "", + "description": "list VPC offerings by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list VPC offerings by id", + "description": "", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list VPC offerings by state", + "description": "list VPC offerings available for VPC creation in specific domain", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "since": "4.18", + "type": "uuid" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "description": "", "length": 255, - "name": "isdefault", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "true if need to list only default VPC offerings. Default value is false", "length": 255, - "name": "pagesize", + "name": "isdefault", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "id of zone VPC offering is associated with", + "description": "list VPC offerings supporting certain services", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "supportedservices", "required": false, - "since": "4.13", - "type": "uuid" + "type": "list" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "list VPC offerings by id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "since": "4.18", "type": "uuid" }, { @@ -9685,9 +10266,9 @@ "type": "string" }, { - "description": "list VPC offerings by display text", + "description": "list VPC offerings by state", "length": 255, - "name": "displaytext", + "name": "state", "required": false, "type": "string" } @@ -9695,57 +10276,29 @@ "related": "updateVPCOffering", "response": [ { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, - {}, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, - { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, { "description": "the service name", "name": "name", @@ -9756,14 +10309,14 @@ "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { "description": "the physical network this belongs to", @@ -9771,8 +10324,8 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -9780,14 +10333,36 @@ "name": "id", "type": "string" }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "services for this provider", "name": "servicelist", "type": "list" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "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" } ], @@ -9797,55 +10372,61 @@ "type": "list" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { "description": "the date this vpc offering was created", "name": "created", "type": "date" }, + {}, + { + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, { "description": "true if vpc offering is default, false otherwise", "name": "isdefault", "type": "boolean" - }, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" } ] }, @@ -9864,12 +10445,6 @@ ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -9880,6 +10455,12 @@ "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", "name": "solidFireVolumeSize", "type": "long" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -9889,11 +10470,12 @@ "name": "uploadVolume", "params": [ { - "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.", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "checksum", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { "description": "Upload volume for the project", @@ -9904,19 +10486,32 @@ "type": "uuid" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "format", + "required": true, + "type": "string" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone the volume is to be hosted on", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, "type": "uuid" }, { @@ -9947,74 +10542,100 @@ "name": "imagestoreuuid", "required": false, "type": "string" + } + ], + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" - } - ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ + }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, {}, { - "description": "the project name of the vpn", - "name": "project", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { "description": "the VM's disk read in KiB", @@ -10022,14 +10643,14 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "shared or local storage", @@ -10037,37 +10658,103 @@ "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -10076,13 +10763,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -10091,13 +10778,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -10109,138 +10796,73 @@ "description": "the account associated with the tag", "name": "account", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "set" }, { - "description": "pod name of the volume", - "name": "podname", - "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { @@ -10249,84 +10871,63 @@ "type": "string" }, { - "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", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, - {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { @@ -10335,29 +10936,9 @@ "type": "long" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" } ] }, @@ -10366,13 +10947,6 @@ "isasync": false, "name": "listSecurityGroups", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -10382,19 +10956,19 @@ "type": "uuid" }, { - "description": "lists security groups by virtual machine id", + "description": "list the security group by the id provided", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "tags", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -10404,16 +10978,17 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "keyword", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists security groups by name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "securitygroupname", + "name": "account", "required": false, "type": "string" }, @@ -10433,90 +11008,46 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "lists security groups by name", "length": 255, - "name": "account", + "name": "securitygroupname", "required": false, "type": "string" }, { - "description": "list the security group by the id provided", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the project id of the group", + "name": "projectid", + "type": "string" }, + {}, + {}, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -10525,8 +11056,13 @@ "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -10535,73 +11071,71 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the description of the security group", "name": "description", "type": "string" }, - {}, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the 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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -10610,18 +11144,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -10635,98 +11169,115 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -10739,28 +11290,28 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -10769,30 +11320,60 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ] }, @@ -10801,6 +11382,13 @@ "isasync": false, "name": "configureOutOfBandManagement", "params": [ + { + "description": "the host management interface port", + "length": 255, + "name": "port", + "required": true, + "type": "string" + }, { "description": "the host management interface driver, for example: ipmitool", "length": 255, @@ -10829,18 +11417,11 @@ "required": true, "type": "string" }, - { - "description": "the host management interface port", - "length": 255, - "name": "port", - "required": true, - "type": "string" - }, { "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -10848,15 +11429,15 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -10864,34 +11445,29 @@ "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, { "description": "the out-of-band management interface username", "name": "username", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { @@ -10899,11 +11475,6 @@ "name": "powerstate", "type": "powerstate" }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, { "description": "the out-of-band management interface port", "name": "port", @@ -10913,28 +11484,39 @@ "description": "the out-of-band management action (if issued)", "name": "action", "type": "string" + }, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" } ], "since": "4.9.0" }, { - "description": "Lists storage tags", + "description": "List OAuth providers registered", "isasync": false, - "name": "listStorageTags", + "name": "listOauthProvider", "params": [ { - "description": "", + "description": "Name of the provider", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the ID of the OAuth provider", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -10942,20 +11524,108 @@ "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": "", + "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ + {}, + { + "description": "Name of the provider", + "name": "name", + "type": "string" + }, + { + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", + "type": "string" + }, + { + "description": "Name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "Description of the provider registered", + "name": "description", + "type": "string" + }, + { + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" + }, + { + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", + "type": "string" + }, + { + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the storage tag", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the provider", "name": "id", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Lists storage tags", + "isasync": false, + "name": "listStorageTags", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { "description": "the pool ID of the storage tag", "name": "poolid", @@ -10967,12 +11637,22 @@ "type": "string" }, {}, + { + "description": "the ID of the storage tag", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -10991,27 +11671,27 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ] }, { @@ -11027,6 +11707,14 @@ "required": false, "type": "uuid" }, + { + "description": "ID of VM", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, { "description": "IDs of VM schedule", "length": 255, @@ -11034,14 +11722,6 @@ "related": "createVMSchedule,listVMSchedule,updateVMSchedule", "required": false, "type": "list" - }, - { - "description": "ID of VM", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,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" } ], "response": [ @@ -11050,22 +11730,22 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ], "since": "4.19.0" @@ -11086,28 +11766,18 @@ ], "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" }, { "description": "the template ID", "name": "id", "type": "string" }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" - }, - {}, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", @@ -11122,174 +11792,149 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" } ] }, { - "description": "Lists annotations.", - "isasync": false, - "name": "listAnnotations", + "description": "Destroys a system virtual machine.", + "isasync": true, + "name": "destroySystemVm", "params": [ { - "description": "", + "description": "The ID of the system virtual machine", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "response": [ + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the id of the entity for which to show annotations", - "length": 255, - "name": "entityid", - "required": false, + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the entity type", - "length": 255, - "name": "entitytype", - "required": false, + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "optional: the id of the user of the annotation", - "length": 255, - "name": "userid", - "required": false, - "since": "4.16.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": false, + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the system VM", + "name": "name", "type": "string" - } - ], - "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the creation timestamp for this annotation", - "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 entity to which this annotation pertains", - "name": "entityname", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, - {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", + "description": "the last disconnected date of host", + "name": "disconnected", "type": "date" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Destroys a system virtual machine.", - "isasync": true, - "name": "destroySystemVm", - "params": [ - { - "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 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 ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -11298,59 +11943,69 @@ "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the 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 Zone ID for the system VM", - "name": "zoneid", + "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 Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "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 first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { @@ -11359,122 +12014,157 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" + } + ] + }, + { + "description": "Lists annotations.", + "isasync": false, + "name": "listAnnotations", + "params": [ { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "optional: the id of the user of the annotation", + "length": 255, + "name": "userid", + "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": false, "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "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 date and time the system VM was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the entity type", + "length": 255, + "name": "entitytype", + "required": false, "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "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": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the 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 Pod name for the system VM", - "name": "podname", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" } - ] + ], + "since": "4.11" }, { "description": "Adds Swift.", @@ -11489,9 +12179,9 @@ "type": "string" }, { - "description": "the username for swift", + "description": " key for the user for swift", "length": 255, - "name": "username", + "name": "key", "required": false, "type": "string" }, @@ -11503,86 +12193,86 @@ "type": "string" }, { - "description": " key for the user for swift", + "description": "the username for swift", "length": 255, - "name": "key", + "name": "username", "required": false, "type": "string" } ], "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "response": [ - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, {}, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the 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 Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the protocol of the image store", + "name": "protocol", "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" } ], "since": "3.0.0" @@ -11593,9 +12283,9 @@ "name": "archiveEvents", "params": [ { - "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, @@ -11607,9 +12297,9 @@ "type": "string" }, { - "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" }, @@ -11623,28 +12313,28 @@ } ], "response": [ - {}, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -11662,6 +12352,11 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "true if operation is executed successfully", @@ -11669,20 +12364,15 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "4.2.0" @@ -11693,105 +12383,109 @@ "name": "listUserData", "params": [ { - "description": "List by keyword", + "description": "the ID of the Userdata", "length": 255, - "name": "keyword", + "name": "id", + "related": "listUserData", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Userdata name to look for", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the Userdata", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listUserData", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Userdata name to look for", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the domain name of the userdata owner", + "name": "domain", "type": "string" }, { - "description": "base64 encoded userdata content", - "name": "userdata", + "description": "the owner id of the userdata", + "name": "accountid", "type": "string" }, - {}, { - "description": "the domain id of the userdata owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the owner id of the userdata", - "name": "accountid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "Name of the userdata", - "name": "name", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "params", "type": "string" }, { @@ -11800,30 +12494,26 @@ "type": "string" }, { - "description": "the domain name of the userdata owner", - "name": "domain", + "description": "base64 encoded userdata content", + "name": "userdata", "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": "Name of the userdata", + "name": "name", + "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "params", + "description": "the domain id of the userdata owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, {} ], "since": "4.18" @@ -11833,14 +12523,6 @@ "isasync": true, "name": "updateLoadBalancer", "params": [ - { - "description": "the ID of the load balancer", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -11856,125 +12538,45 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "the ID of the load balancer", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, { "description": "the name of the Load Balancer", "name": "name", "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", "response": [ { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the state of the load balancer rule", - "name": "state", + "description": "resource type", + "name": "resourcetype", "type": "string" }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - } - ], - "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": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -11983,18 +12585,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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 project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -12003,17 +12605,21 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, - {}, { - "description": "the Load Balancer ID", - "name": "id", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { @@ -12021,8 +12627,8 @@ "name": "loadbalancerinstance", "response": [ { - "description": "the name of the instance", - "name": "name", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { @@ -12030,18 +12636,102 @@ "name": "id", "type": "string" }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, { "description": "the state of the instance", "name": "state", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" } ], "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the Load Balancer ID", + "name": "id", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" } ], "since": "4.4.0" @@ -12078,48 +12768,55 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + {}, + {}, + { + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "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 last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the Pod ID for the system VM", + "name": "podid", "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" }, { @@ -12128,13 +12825,13 @@ "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", + "description": "the last disconnected date of host", + "name": "disconnected", "type": "date" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { @@ -12142,101 +12839,94 @@ "name": "privatenetmask", "type": "string" }, - {}, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the host ID for the system VM", + "name": "hostid", "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": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the system VM type", + "name": "systemvmtype", "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 name of the system VM", - "name": "name", + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -12245,39 +12935,49 @@ "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" } ] }, @@ -12287,10 +12987,10 @@ "name": "listSnapshotPolicies", "params": [ { - "description": "the ID of the disk volume", + "description": "the ID of the snapshot policy", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "id", + "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", "required": false, "type": "uuid" }, @@ -12302,25 +13002,25 @@ "type": "integer" }, { - "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": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "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" }, @@ -12335,17 +13035,49 @@ "related": "createSnapshotPolicy,updateSnapshotPolicy", "response": [ { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + {}, + { + "description": "the 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": "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 project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -12354,95 +13086,68 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, { "description": "the interval type of the snapshot policy", "name": "intervaltype", "type": "short" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, - { - "description": "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": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - {} + } ] }, { @@ -12451,40 +13156,41 @@ "name": "updateVpnCustomerGateway", "params": [ { - "description": "Force encapsulation for Nat Traversal", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "forceencap", + "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", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "ikeversion", - "required": false, - "since": "4.15.1", + "name": "esppolicy", + "required": true, "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "Force encapsulation for Nat Traversal", "length": 255, - "name": "esplifetime", + "name": "forceencap", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "id of 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": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, "type": "uuid" }, { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", "length": 255, - "name": "cidrlist", - "required": true, + "name": "ikeversion", + "required": false, + "since": "4.15.1", "type": "string" }, { @@ -12502,55 +13208,54 @@ "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "ikelifetime", - "required": false, - "type": "long" + "name": "cidrlist", + "required": true, + "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "name of this customer gateway", "length": 255, - "name": "dpd", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "name of this customer gateway", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "name", + "name": "esplifetime", "required": false, - "type": "string" + "type": "long" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "splitconnections", + "name": "dpd", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "ESP policy of the customer gateway", + "description": "id of customer gateway", "length": 255, - "name": "esppolicy", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "account", + "name": "ikelifetime", "required": false, - "type": "string" + "type": "long" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "description": "the account associated with the gateway. 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": "public ip address id of the customer gateway", @@ -12563,8 +13268,8 @@ "related": "createVpnCustomerGateway,listVpnCustomerGateways", "response": [ { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the project name", + "name": "project", "type": "string" }, { @@ -12573,44 +13278,90 @@ "type": "boolean" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "name of the customer gateway", + "name": "name", + "type": "string" + }, + {}, + { + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "the owner", + "name": "account", "type": "string" }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, { "description": "guest ip of the customer gateway", "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { "description": "IPsec preshared-key of customer gateway", "name": "ipsecpsk", "type": "string" }, - {}, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "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", + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -12618,68 +13369,120 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, { "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, - {}, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + } + ] + }, + { + "description": "Verify the OAuth Code and fetch the corresponding user from provider", + "isasync": false, + "name": "verifyOAuthCodeAndGetUser", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, + "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "updateOauthProvider", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "Description of the provider registered", + "name": "description", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, { - "description": "the vpn gateway ID", + "description": "ID of the provider", "name": "id", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the customer gateway", + "description": "Name of the provider", "name": "name", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", + "type": "string" + }, + {}, + { + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", + "type": "string" } - ] + ], + "since": "4.19.0" }, { "description": "apply Tungsten-Fabric tag", @@ -12687,25 +13490,25 @@ "name": "applyTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of networks", "length": 255, - "name": "policyuuid", + "name": "networkuuid", "required": false, - "type": "string" + "type": "list" }, { - "description": "the uuid of nics", + "description": "the uuid of vms", "length": 255, - "name": "nicuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the uuid of vms", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "vmuuid", + "name": "applicationpolicysetuuid", "required": false, - "type": "list" + "type": "string" }, { "description": "the ID of zone", @@ -12715,13 +13518,6 @@ "required": true, "type": "uuid" }, - { - "description": "the uuid of networks", - "length": 255, - "name": "networkuuid", - "required": false, - "type": "list" - }, { "description": "the uuid of Tungsten-Fabric tag", "length": 255, @@ -12730,23 +13526,37 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of nics", "length": 255, - "name": "applicationpolicysetuuid", + "name": "nicuuid", + "required": false, + "type": "list" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", "required": false, "type": "string" } ], "related": "createTungstenFabricTag,removeTungstenFabricTag", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, { @@ -12755,18 +13565,18 @@ "type": "long" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { @@ -12780,55 +13590,50 @@ "type": "list" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" - }, - {}, - {}, - { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" } ] }, { - "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "description": "Updates object storage pool", "isasync": false, - "name": "lockAccount", + "name": "updateObjectStoragePool", "params": [ { - "description": "Locks the specified account.", + "description": "Object Store ID", "length": 255, - "name": "account", + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", "required": true, + "type": "uuid" + }, + { + "description": "the name for the object store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Locks the specified account on this domain.", + "description": "the url for the object store", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "name": "url", + "required": false, + "type": "string" } ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "related": "addObjectStoragePool,listObjectStoragePools", "response": [ { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { @@ -12837,80 +13642,106 @@ "type": "integer" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the object store currently used size", + "name": "storageused", "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of the object store", + "name": "name", "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, + {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "List DRS plans for a clusters", + "isasync": false, + "name": "listClusterDrsPlan", + "params": [ + { + "description": "ID of the drs plan", + "length": 255, + "name": "id", + "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "generateClusterDrsPlan,executeClusterDrsPlan", + "response": [ {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, + {}, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "Start event Id of the DRS Plan", + "name": "eventid", + "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -12919,49 +13750,65 @@ "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + } + ], + "since": "4.19.0" + }, + { + "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "isasync": false, + "name": "lockAccount", + "params": [ { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "Locks the specified account on this domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" }, { - "description": "the state of the account", - "name": "state", + "description": "Locks the specified account.", + "length": 255, + "name": "account", + "required": true, "type": "string" - }, + } + ], + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ { "description": "the name of the account", "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { "description": "the total number of projects the account can own", @@ -12969,73 +13816,123 @@ "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "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 sent", + "name": "sentbytes", + "type": "long" + }, { "description": "the total number of projects being administrated by this account", "name": "projecttotal", "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total 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 public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { @@ -13044,53 +13941,114 @@ "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, { "description": "the ID of the role", "name": "roleid", "type": "string" }, + {}, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { "description": "the total number of virtual machines stopped for this account", "name": "vmstopped", "type": "integer" }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the domain ID of the user", @@ -13098,38 +14056,38 @@ "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -13138,29 +14096,34 @@ "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 secret key of the user", - "name": "secretkey", + "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", + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -13168,67 +14131,73 @@ "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 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 lastname", - "name": "lastname", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" } ], "type": "list" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { "description": "the total number of network traffic bytes received", @@ -13236,14 +14205,19 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" } ] }, @@ -13261,7 +14235,7 @@ "type": "uuid" }, { - "description": "Force stop the VM. The caller knows the VM is stopped.", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, "name": "forced", "required": false, @@ -13271,8 +14245,33 @@ "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { @@ -13308,8 +14307,8 @@ "type": "list" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { @@ -13317,23 +14316,58 @@ "name": "guestnetworkid", "type": "string" }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { @@ -13342,64 +14376,54 @@ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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": "Type of adapter if available", - "name": "adaptertype", + "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 type of the nic", + "name": "type", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "name": "macaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { "description": "MTU configured on the NIC", @@ -13407,59 +14431,69 @@ "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -13470,18 +14504,19 @@ "type": "set" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, + {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -13490,53 +14525,33 @@ "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the 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", "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": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { @@ -13545,58 +14560,53 @@ "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -13605,120 +14615,94 @@ "type": "date" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the id of the router", + "name": "id", "type": "string" }, - {}, { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the Zone name for the router", + "name": "zonename", "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 domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the name of the router", + "name": "name", "type": "string" } ] @@ -13729,52 +14713,52 @@ "name": "listClusters", "params": [ { - "description": "lists clusters by Pod ID", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "lists clusters by Pod ID", "length": 255, - "name": "allocationstate", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "managedstate", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists clusters by cluster type", + "description": "List by keyword", "length": 255, - "name": "clustertype", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "flag to display the capacity of the clusters", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "showcapacities", + "name": "managedstate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "lists clusters by hypervisor type", + "description": "lists clusters by allocation state", "length": 255, - "name": "hypervisor", + "name": "allocationstate", "required": false, "type": "string" }, @@ -13789,21 +14773,21 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "lists clusters by the cluster name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "lists clusters by cluster type", "length": 255, - "name": "name", + "name": "clustertype", "required": false, "type": "string" }, @@ -13819,48 +14803,59 @@ "related": "addCluster,updateCluster", "response": [ { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, + {}, { "description": "Meta data associated with the zone (key/value pairs)", "name": "resourcedetails", "type": "map" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { @@ -13873,24 +14868,39 @@ "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { "description": "the Cluster name", @@ -13903,74 +14913,48 @@ "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { "description": "the Zone name", "name": "zonename", "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" } ], "type": "list" }, - {}, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, {}, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" } ] }, @@ -13990,27 +14974,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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -14020,12 +15004,18 @@ "name": "listProjectInvitations", "params": [ { - "description": "list invitation by user ID", + "description": "List by keyword", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", @@ -14042,14 +15032,6 @@ "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, @@ -14058,18 +15040,20 @@ "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list invitation by user ID", "length": 255, - "name": "listall", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list invitations by id", "length": 255, - "name": "account", + "name": "id", + "related": "listProjectInvitations", "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.", @@ -14086,33 +15070,33 @@ "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "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 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" } ], "related": "", "response": [ { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the account name of the project's owner", + "name": "account", "type": "string" }, { @@ -14120,26 +15104,16 @@ "name": "project", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account name of the project's owner", - "name": "account", - "type": "string" - }, - {}, {}, { "description": "the email the invitation was sent to", "name": "email", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the invitation", + "name": "id", "type": "string" }, { @@ -14148,23 +15122,33 @@ "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", + "description": "the current status of the latest async job acting 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 project", - "name": "projectid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the invitation state", + "name": "state", + "type": "string" + }, + { + "description": "the id of the project", + "name": "projectid", "type": "string" } ], @@ -14190,29 +15174,23 @@ "required": true, "type": "string" }, - { - "description": "the sequence of Tungsten-Fabric firewall policy", - "length": 255, - "name": "sequence", - "required": true, - "type": "integer" - }, { "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, "name": "applicationpolicysetuuid", "required": false, "type": "string" + }, + { + "description": "the sequence of Tungsten-Fabric firewall policy", + "length": 255, + "name": "sequence", + "required": true, + "type": "integer" } ], "related": "listTungstenFabricFirewallPolicy", "response": [ - {}, - { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", @@ -14223,26 +15201,32 @@ "name": "uuid", "type": "string" }, - {}, { "description": "list Tungsten-Fabric firewall rule", "name": "firewallrule", "type": "list" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", + "type": "string" } ] }, @@ -14252,18 +15236,20 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "Lists rule with the specified ID.", @@ -14274,25 +15260,24 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of IP address of the firewall services", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, @@ -14304,11 +15289,11 @@ "type": "boolean" }, { - "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", @@ -14319,19 +15304,18 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list 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)", @@ -14351,14 +15335,35 @@ ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ + {}, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the ending port of 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": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { @@ -14366,128 +15371,107 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - {}, - { - "description": "the 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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { "description": "the network id of the firewall rule", "name": "networkid", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ] @@ -14522,40 +15506,40 @@ "related": "addRegion,listRegions", "response": [ { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the ID of the region", "name": "id", "type": "integer" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the name of the region", + "name": "name", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, - {}, { "description": "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" - }, - { - "description": "the name of the region", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -14575,28 +15559,28 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -14606,20 +15590,26 @@ "name": "listClustersMetrics", "params": [ { - "description": "lists clusters by Pod ID", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists clusters by cluster type", + "description": "List by keyword", "length": 255, - "name": "clustertype", + "name": "keyword", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "lists clusters by Zone ID", "length": 255, @@ -14629,201 +15619,129 @@ "type": "uuid" }, { - "description": "lists clusters by hypervisor type", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "lists clusters by allocation state", "length": 255, - "name": "page", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "lists clusters by the cluster name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by cluster type", "length": 255, - "name": "showcapacities", + "name": "clustertype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "name", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Pod ID", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "managedstate", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "", "length": 255, - "name": "allocationstate", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" - }, { "description": "the total cpu used in Ghz", "name": "cpuused", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - {}, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, { "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", - "type": "long" - }, { "description": "the capacity type", "name": "type", "type": "short" }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, { "description": "the Zone name", "name": "zonename", "type": "string" }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the total capacity available", @@ -14834,33 +15752,53 @@ "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" } ], "type": "list" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", "type": "string" }, { @@ -14869,20 +15807,20 @@ "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, - {}, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the cluster ID", + "name": "id", "type": "string" }, + {}, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" }, { "description": "cpu usage disable threshold exceeded", @@ -14890,139 +15828,183 @@ "type": "boolean" }, { - "description": "state of the cluster", - "name": "state", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, + {}, { "description": "cpu usage notification threshold exceeded", "name": "cputhreshold", "type": "boolean" }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, { "description": "memory allocated disable threshold exceeded", "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" } ], "since": "4.9.3" }, { - "description": "Creates a user-defined VM backup schedule", + "description": "Lists objects at specified path on a storage pool.", "isasync": false, - "name": "createBackupSchedule", + "name": "listStoragePoolObjects", "params": [ { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "List by keyword", "length": 255, - "name": "intervaltype", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "path to list on storage pool", "length": 255, - "name": "timezone", - "required": true, + "name": "path", + "required": false, "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)", + "description": "", "length": 255, - "name": "schedule", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "updateBackupSchedule,listBackups", + "related": "listImageStoreObjects", "response": [ { - "description": "backup size in bytes", - "name": "size", - "type": "long" - }, - { - "description": "name of the VM", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "zone name", - "name": "zone", - "type": "string" + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, {}, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, + {}, { - "description": "account name", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", - "type": "string" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "zone id", - "name": "zoneid", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { @@ -15031,72 +16013,23 @@ "type": "integer" }, { - "description": "external backup id", - "name": "externalid", - "type": "string" - }, - { - "description": "domain id", - "name": "domainid", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" - }, - { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", + "description": "Size is in Bytes.", + "name": "size", "type": "long" - }, - { - "description": "backup type", - "name": "type", - "type": "string" - }, - { - "description": "backed up volumes", - "name": "volumes", - "type": "string" - }, - { - "description": "domain name", - "name": "domain", - "type": "string" - }, - { - "description": "account id", - "name": "accountid", - "type": "string" - }, - { - "description": "backup date", - "name": "created", - "type": "string" - }, - {}, - { - "description": "backup offering name", - "name": "backupofferingname", - "type": "string" } ], - "since": "4.14.0" + "since": "4.19.0" }, { "description": "Lists a project's project role permissions", "isasync": false, "name": "listProjectRolePermissions", "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, { "description": "ID of the project", "length": 255, @@ -15104,33 +16037,38 @@ "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 permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "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 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { @@ -15139,22 +16077,25 @@ "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the ID of the project role permission", "name": "id", "type": "string" }, - {} + { + "description": "the ID of the project", + "name": "projectid", + "type": "string" + } ], "since": "4.15.0" }, @@ -15164,26 +16105,26 @@ "name": "listLdapConfigurations", "params": [ { - "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "integer" }, { - "description": "Port", + "description": "Hostname", "length": 255, - "name": "port", + "name": "hostname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "since": "4.13.2", + "type": "boolean" }, { "description": "", @@ -15193,54 +16134,54 @@ "type": "integer" }, { - "description": "linked domain", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "linked domain", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Hostname", + "description": "Port", "length": 255, - "name": "hostname", + "name": "port", "required": false, - "type": "string" + "type": "integer" } ], "related": "addLdapConfiguration,deleteLdapConfiguration", "response": [ + {}, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "linked domain", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "port teh ldap server is running on", + "description": "port the ldap server is running on", "name": "port", "type": "int" } @@ -15253,18 +16194,20 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the staging store provider", + "description": "the ID of the staging store", "length": 255, - "name": "provider", + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -15273,6 +16216,13 @@ "required": false, "type": "integer" }, + { + "description": "the staging store provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -15281,12 +16231,11 @@ "type": "integer" }, { - "description": "the Zone ID for the staging store", + "description": "the name of the staging store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the staging store protocol", @@ -15295,14 +16244,6 @@ "required": false, "type": "string" }, - { - "description": "the ID of the staging store", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -15313,17 +16254,6 @@ ], "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, { "description": "the protocol of the image store", "name": "protocol", @@ -15335,34 +16265,39 @@ "type": "string" }, {}, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, { "description": "defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -15371,18 +16306,24 @@ "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -15400,13 +16341,6 @@ "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. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - }, { "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, @@ -15416,18 +16350,18 @@ "type": "uuid" }, { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "iprange", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, - "name": "fordisplay", + "name": "openfirewall", "required": false, - "since": "4.4", "type": "boolean" }, { @@ -15437,60 +16371,61 @@ "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" + }, + { + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "length": 255, + "name": "iprange", + "required": false, + "type": "string" } ], "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "response": [ { - "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 ipsec preshared key", - "name": "presharedkey", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { "description": "the account of the remote access vpn", "name": "account", "type": "string" }, - { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, { "description": "the id of the remote access vpn", "name": "id", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -15498,19 +16433,25 @@ "name": "iprange", "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 domain name of the account of the remote access vpn", - "name": "domain", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" } ] @@ -15532,8 +16473,23 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", "type": "string" }, { @@ -15541,14 +16497,9 @@ "name": "healthcheckresults", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" }, { "description": "detailed response generated on running health check", @@ -15561,76 +16512,46 @@ "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": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -15639,130 +16560,104 @@ "type": "state" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, - {}, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, - {}, { - "description": "the version of template", - "name": "version", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the id of the router", + "name": "id", "type": "string" }, { @@ -15770,28 +16665,33 @@ "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -15800,161 +16700,191 @@ "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the 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", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "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 type of the nic", + "name": "type", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public IP address for the router", + "name": "publicip", "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 ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, { "description": "the network domain for the router", "name": "networkdomain", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "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": "role of the domain router", - "name": "role", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { @@ -15962,25 +16892,46 @@ "name": "requiresupgrade", "type": "boolean" }, + {}, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, { "description": "true if any health checks had failed", "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" } ] }, @@ -15996,30 +16947,6 @@ "required": false, "type": "map" }, - { - "description": "the service offering ID to apply to the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" - }, { "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, @@ -16036,6 +16963,14 @@ "since": "4.17", "type": "boolean" }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, { "description": "New maximum number of IOPS for the custom disk offering", "length": 255, @@ -16043,189 +16978,154 @@ "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": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the 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 name of the virtual machine", - "name": "name", + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - {}, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "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": "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -16234,338 +17134,39 @@ "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "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 group ID of the virtual machine", - "name": "groupid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - { - "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 id of userdata used for the VM", "name": "userdataid", "type": "string" }, + {}, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id of the group", + "name": "projectid", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "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": "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account owning the security group", + "name": "account", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the 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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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 user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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 ID of the security group", @@ -16578,61 +17179,61 @@ "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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -16641,18 +17242,18 @@ "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": "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" }, { @@ -16661,44 +17262,34 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -16707,81 +17298,44 @@ "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", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "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 name where tag belongs to", - "name": "project", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ { "description": "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", @@ -16792,28 +17346,33 @@ "name": "tags", "response": [ { - "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -16827,230 +17386,647 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" } ], "type": "set" }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicipid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", "name": "memoryintfreekbs", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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 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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "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 name of the affinity group", - "name": "name", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "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 ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the domain name of the affinity group", + "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 value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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" } ] @@ -17068,6 +18044,21 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the configuration", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the ID of the Zone to reset the parameter value for corresponding zone", "length": 255, @@ -17092,13 +18083,6 @@ "required": false, "type": "uuid" }, - { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, @@ -17106,42 +18090,34 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, "type": "uuid" - }, - { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" } ], "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, {}, { - "description": "the category of the configuration", - "name": "category", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the value of the configuration", + "name": "value", + "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { @@ -17150,60 +18126,60 @@ "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the name of the configuration", + "name": "name", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the default value of the configuration", "name": "defaultvalue", "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" } ], "since": "4.16.0" @@ -17214,12 +18190,20 @@ "name": "listGuestOsMapping", "params": [ { - "description": "list Guest OS mapping by hypervisor", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "hypervisor", + "name": "hypervisorversion", "required": false, "type": "string" }, + { + "description": "list mapping by its UUID", + "length": 255, + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -17235,16 +18219,16 @@ "type": "string" }, { - "description": "list Guest OS mapping by OS display name", + "description": "list Guest OS mapping by OS mapping name with hypervisor", "length": 255, - "name": "osdisplayname", + "name": "osnameforhypervisor", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by OS mapping name with hypervisor", + "description": "list Guest OS mapping by hypervisor", "length": 255, - "name": "osnameforhypervisor", + "name": "hypervisor", "required": false, "type": "string" }, @@ -17257,17 +18241,9 @@ "type": "uuid" }, { - "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", + "description": "list Guest OS mapping by OS display name", "length": 255, - "name": "hypervisorversion", + "name": "osdisplayname", "required": false, "type": "string" }, @@ -17281,35 +18257,25 @@ ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ - {}, { "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, - { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" - }, { "description": "is the mapping user defined", "name": "isuserdefined", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the hypervisor", - "name": "hypervisor", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { @@ -17318,8 +18284,8 @@ "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { @@ -17327,7 +18293,17 @@ "name": "ostypeid", "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" }, @@ -17337,71 +18313,71 @@ "name": "listTemplates", "params": [ { - "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": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "details", "required": false, - "type": "uuid" + "since": "4.15", + "type": "list" }, { - "description": "If set to true, list only unique templates across zones", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "showunique", + "name": "tags", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "map" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "List by keyword", "length": 255, - "name": "details", + "name": "keyword", "required": false, - "since": "4.15", - "type": "list" + "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "", "length": 255, - "name": "showicon", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list templates by zoneId", + "description": "show removed templates as well", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "showremoved", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "keyword", + "name": "showunique", "required": false, - "type": "string" + "since": "4.13.2", + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the template ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "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.", @@ -17411,143 +18387,161 @@ "type": "boolean" }, { - "description": "the hypervisor for which to restrict the search", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "hypervisor", + "name": "ids", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { "description": "list datadisk templates by parent template id", "length": 255, "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "since": "4.4", "type": "uuid" }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the template name", + "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": "name", - "required": false, + "name": "templatefilter", + "required": true, "type": "string" }, { - "description": "show removed templates as well", + "description": "the type of the template", "length": 255, - "name": "showremoved", + "name": "templatetype", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" }, { - "description": "the template ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "ID of the image or image cache store", "length": 255, - "name": "tags", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, - "type": "map" + "since": "4.19", + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list templates by zoneId", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "the template name", "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "name", "required": false, - "since": "4.9", - "type": "list" - } - ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.19", + "type": "uuid" + } + ], + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the template name", "name": "name", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -17556,18 +18550,70 @@ "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 zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -17576,38 +18622,33 @@ "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -17615,29 +18656,45 @@ "name": "isextractable", "type": "boolean" }, + {}, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -17646,13 +18703,18 @@ "type": "string" }, { - "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 type of the template", - "name": "templatetype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -17661,157 +18723,105 @@ "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "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 template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + {}, + { + "description": "the template ID", + "name": "id", "type": "string" }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { "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": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, - {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "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 ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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 project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { "description": "the format of the template.", "name": "format", "type": "imageformat" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" } ] }, @@ -17820,20 +18830,6 @@ "isasync": true, "name": "createAutoScalePolicy", "params": [ - { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "length": 255, - "name": "action", - "required": true, - "type": "string" - }, - { - "description": "the duration in which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": true, - "type": "integer" - }, { "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, @@ -17849,6 +18845,20 @@ "since": "4.18.0", "type": "string" }, + { + "description": "the duration in which the conditions have to be true before action is taken", + "length": 255, + "name": "duration", + "required": true, + "type": "integer" + }, + { + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, { "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, @@ -17861,38 +18871,34 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "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", "type": "list" }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - }, { "description": "the account owning the autoscale policy", "name": "account", "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" + }, + { + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { @@ -17901,27 +18907,31 @@ "type": "integer" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "name": "action", "type": "string" }, + { + "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", @@ -17938,16 +18948,16 @@ "description": "the host ID of ssp server", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -17955,12 +18965,12 @@ "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", @@ -17974,27 +18984,28 @@ "name": "createTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric policy name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric policy name", + "description": "the ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listTungstenFabricPolicy,removeTungstenFabricPolicyRule,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "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", @@ -18006,12 +19017,6 @@ "name": "name", "type": "string" }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, - {}, {}, { "description": "Tungsten-Fabric provider zone name", @@ -18023,11 +19028,16 @@ "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" } ] }, @@ -18038,202 +19048,308 @@ "params": [], "related": "", "response": [ - {}, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, { "description": "the name of the active usage server", "name": "hostname", "type": "string" }, + {}, + { + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", - "type": "date" - }, { "description": "the state of the usage server", "name": "state", "type": "state" }, { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" - }, - { - "description": "the time these statistics were collected", - "name": "collectiontime", + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", "type": "date" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.17.0" }, { - "description": "configure simulator", - "isasync": false, - "name": "configureSimulator", + "description": "Creates a bucket in the specified object storage pool. ", + "isasync": true, + "name": "createBucket", "params": [ { - "description": "configure range: in a cluster", + "description": "Id of the Object Storage Pool where bucket is created", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, + "name": "objectstorageid", + "related": "addObjectStoragePool,listObjectStoragePools", + "required": true, "type": "uuid" }, { - "description": "configuration options for this command, which is separated by ;", + "description": "Enable bucket encryption", "length": 255, - "name": "value", - "required": true, + "name": "encryption", + "required": false, + "type": "boolean" + }, + { + "description": "The Bucket access policy", + "length": 255, + "name": "policy", + "required": false, "type": "string" }, { - "description": "configure range: in a pod", + "description": "Bucket Quota in GB", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "quota", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "configure range: in a host", + "description": "the account associated with the bucket. Must be used with the domainId parameter.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "Enable bucket versioning", + "length": 255, + "name": "versioning", + "required": false, + "type": "boolean" }, { - "description": "which command needs to be configured", + "description": "the name of the bucket", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "agent command response to be returned", - "length": 4096, - "name": "jsonresponse", + "description": "Enable object locking in bucket", + "length": 255, + "name": "objectlocking", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "configure range: in a zone", + "description": "the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "number of times the mock is active", + "description": "the project associated with the bucket. Mutually exclusive with account parameter", "length": 255, - "name": "count", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "querySimulatorMock", + "related": "listBuckets", "response": [ { - "description": "the agent command to be mocked", - "name": "name", + "description": "the domain associated with the bucket", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, {}, { - "description": "the Pod ID scope of the mock", - "name": "podid", - "type": "long" + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" }, { - "description": "number of times mock is executed, if not specified then mock remains active till cleaned up", - "name": "count", - "type": "integer" + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" }, { - "description": "the Zone ID scope of the mock", - "name": "zoneid", - "type": "long" + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" }, { - "description": "the Cluster ID scope of the mock", - "name": "clusterid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the Host ID scope of the mock", - "name": "hostid", - "type": "long" + "description": "Bucket URL", + "name": "url", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { - "description": "the mock ID", + "description": "Bucket Quota in GB", + "name": "quota", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "description": "ID of the Bucket", "name": "id", - "type": "long" + "type": "string" }, - {} - ] - }, - { - "description": "Enables HA for a zone", - "isasync": true, - "name": "enableHAForZone", - "params": [ { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" + }, + { + "description": "Bucket Encryption", + "name": "encryption", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the bucket", + "name": "projectid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, - {}, - {} + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "Object storage provider", + "name": "provider", + "type": "string" + }, + { + "description": "name of the Bucket", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], - "since": "4.11" + "since": "4.19.0" }, { "description": "Lists physical networks", @@ -18241,19 +19357,19 @@ "name": "listPhysicalNetworks", "params": [ { - "description": "List by keyword", + "description": "the Zone ID for the physical network", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list physical network by id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "search by name", @@ -18262,14 +19378,6 @@ "required": false, "type": "string" }, - { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -18283,13 +19391,36 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "list physical network by id", + "length": 255, + "name": "id", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" } ], "related": "createPhysicalNetwork,updatePhysicalNetwork", "response": [ { - "description": "state of the physical network", - "name": "state", + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the vlan of the physical network", + "name": "vlan", + "type": "string" + }, + { + "description": "the uuid of the physical network", + "name": "id", + "type": "string" + }, + { + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -18298,8 +19429,8 @@ "type": "integer" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "name of the physical network", + "name": "name", "type": "string" }, {}, @@ -18309,53 +19440,78 @@ "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", - "type": "string" - }, - { - "description": "the uuid of the physical network", - "name": "id", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, {}, { - "description": "name of the physical network", - "name": "name", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Enables HA for a zone", + "isasync": true, + "name": "enableHAForZone", + "params": [ + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "zone name of the physical network", - "name": "zonename", + "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" + "since": "4.11" }, { "description": "Lists all firewall rules for an IP address.", @@ -18363,16 +19519,24 @@ "name": "listFirewallRules", "params": [ { - "description": "", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "pagesize", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -18384,44 +19548,42 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list firewall rules for certain network", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list firewall rules for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" }, { - "description": "the ID of IP address of the firewall services", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "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.", @@ -18430,13 +19592,6 @@ "required": false, "type": "boolean" }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -18446,17 +19601,18 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" } @@ -18469,37 +19625,55 @@ "type": "integer" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "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 ID of the firewall rule", + "name": "id", + "type": "string" }, { "description": "the protocol of the firewall rule", "name": "protocol", "type": "string" }, - {}, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "the ending port of firewall rule's port range", "name": "endport", "type": "integer" }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the starting port of firewall rule's port range", "name": "startport", @@ -18510,18 +19684,18 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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" }, { @@ -18530,51 +19704,41 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -18583,25 +19747,17 @@ "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - } + {}, + {} ] }, { @@ -18610,13 +19766,18 @@ "name": "cleanVMReservations", "params": [], "response": [ + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -18626,11 +19787,6 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -18649,23 +19805,23 @@ } ], "response": [ - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -18678,18 +19834,11 @@ "isasync": true, "name": "extractIso", "params": [ - { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, { "description": "the ID of the ISO file", "length": 255, "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, @@ -18701,6 +19850,13 @@ "required": false, "type": "uuid" }, + { + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, { "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, @@ -18709,82 +19865,157 @@ "type": "string" } ], - "related": "extractTemplate,extractVolume", + "related": "downloadImageStoreObject,extractTemplate,extractVolume", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the account id to which the extracted object belongs", "name": "accountid", "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 percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "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": "the id of extracted object", "name": "id", "type": "string" }, {}, + {}, + { + "description": "the status of the extraction", + "name": "status", + "type": "string" + }, + { + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, { "description": "", "name": "resultstring", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the mode of extraction - upload or download", "name": "extractMode", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "type of the storage", + "name": "storagetype", + "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "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": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the extracted object", + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the object store", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the object store provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + } + ], + "related": "addObjectStoragePool", + "response": [ + {}, + { + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the url of the object store", + "name": "url", "type": "string" }, {}, @@ -18792,8 +20023,34 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the provider name of the object store", + "name": "providername", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the object store currently used size", + "name": "storageused", + "type": "long" + }, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" + }, + { + "description": "the name of the object store", + "name": "name", + "type": "string" } - ] + ], + "since": "4.19.0" }, { "description": "create secondary staging store.", @@ -18801,18 +20058,18 @@ "name": "createSecondaryStagingStore", "params": [ { - "description": "the staging store provider name", + "description": "the details for the staging store", "length": 255, - "name": "provider", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the details for the staging store", + "description": "the staging store provider name", "length": 255, - "name": "details", + "name": "provider", "required": false, - "type": "map" + "type": "string" }, { "description": "the Zone ID for the staging store", @@ -18822,94 +20079,94 @@ "required": false, "type": "uuid" }, - { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, { "description": "the scope of the staging store: zone only for now", "length": 255, "name": "scope", "required": false, "type": "string" + }, + { + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" } ], "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "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 protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the name of the image store", - "name": "name", + "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 scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "the total disk size of the host", "name": "disksizetotal", "type": "long" }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -18934,13 +20191,6 @@ "required": false, "type": "uuid" }, - { - "description": "optional description of the affinity group", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "name of the affinity group", "length": 255, @@ -18955,6 +20205,13 @@ "required": false, "type": "string" }, + { + "description": "optional description of the affinity group", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "Type of the affinity group from the available affinity/anti-affinity group types", "length": 255, @@ -18965,15 +20222,46 @@ ], "related": "", "response": [ + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, {}, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on 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 affinity group", - "name": "name", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -18981,66 +20269,205 @@ "name": "description", "type": "string" }, - {}, { "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ] + }, + { + "description": "Remove a VMware datacenter from a zone.", + "isasync": false, + "name": "removeVmwareDc", + "params": [ + { + "description": "The id of Zone from which VMware datacenter has to be removed.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project name of the affinity group", - "name": "project", + "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": "Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "isasync": false, + "name": "oauthlogin", + "params": [ + { + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "length": 255, + "name": "domainId", + "required": false, + "type": "long" + }, + { + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, "type": "string" }, { - "description": "the account owning the affinity group", + "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": "Email id with which user tried to login using OAuth provider", + "length": 255, + "name": "email", + "required": true, + "type": "string" + } + ], + "related": "login", + "response": [ + { + "description": "Username", + "name": "username", + "type": "string" + }, + { + "description": "user time zone", + "name": "timezone", + "type": "string" + }, + { + "description": "the account name the user belongs to", "name": "account", "type": "string" }, + { + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" + }, + { + "description": "User ID", + "name": "userid", + "type": "string" + }, + { + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the type of the affinity group", + "description": "Is user registered", + "name": "registered", + "type": "string" + }, + {}, + { + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + { + "description": "first name of the user", + "name": "firstname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "last name of the user", + "name": "lastname", + "type": "string" + }, + { + "description": "the account type (admin, domain-admin, read-only-admin, user)", "name": "type", "type": "string" }, + {}, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" + }, + { + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" + }, + { + "description": "Domain ID that the user belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "Is two factor authentication enabled", + "name": "is2faenabled", + "type": "string" + }, + { + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", + "type": "string" } - ] + ], + "since": "4.19.0" }, { "description": "Lists all available Internal Load Balancer elements.", "isasync": false, "name": "listInternalLoadBalancerElements", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -19049,10 +20476,10 @@ "type": "string" }, { - "description": "list internal load balancer elements by network service provider id", + "description": "list internal load balancer elements by id", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "id", + "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "required": false, "type": "uuid" }, @@ -19064,12 +20491,11 @@ "type": "boolean" }, { - "description": "list internal load balancer elements by id", + "description": "", "length": 255, - "name": "id", - "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -19077,32 +20503,40 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "list internal load balancer elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "required": false, + "type": "uuid" } ], "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" }, { "description": "the physical network service provider id of the element", "name": "nspid", "type": "string" }, - {}, - { - "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", @@ -19116,6 +20550,14 @@ "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": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, @@ -19131,19 +20573,10 @@ "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", - "type": "string" } ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ - {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", @@ -19153,30 +20586,25 @@ "name": "id", "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": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", "type": "int" }, { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" }, { "description": "the state of the policy", @@ -19189,38 +20617,38 @@ "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ], "type": "list" }, + {}, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the id of the zone the HealthCheck policy belongs to", "name": "zoneid", "type": "string" }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "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 of the HealthCheck policy", + "name": "domain", + "type": "string" }, { "description": "the account of the HealthCheck policy", @@ -19231,7 +20659,13 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + {} ], "since": "4.4" }, @@ -19264,50 +20698,50 @@ ], "related": "", "response": [ + {}, { "description": "the hypervisor", "name": "hypervisor", "type": "string" }, + { + "description": "version of the hypervisor for guest os names", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" + }, { "description": "the guest OS list of the hypervisor", "name": "guestoslist", "response": [ { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" } ], "type": "list" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the guest OS count of the hypervisor", - "name": "guestoscount", - "type": "integer" - }, - {} + } ], "since": "4.19.0" }, @@ -19316,13 +20750,6 @@ "isasync": true, "name": "removeTungstenFabricPolicyRule", "params": [ - { - "description": "the Uuid of Tungsten-Fabric policy rule", - "length": 255, - "name": "ruleuuid", - "required": true, - "type": "string" - }, { "description": "the Uuid of Tungsten-Fabric policy", "length": 255, @@ -19337,21 +20764,21 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the Uuid of Tungsten-Fabric policy rule", + "length": 255, + "name": "ruleuuid", + "required": true, + "type": "string" } ], "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "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", @@ -19360,23 +20787,30 @@ }, {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, + {}, + {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } ] @@ -19394,17 +20828,10 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", - "length": 255, - "name": "tungstengateway", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric provider name", + "description": "Tungsten-Fabric provider port", "length": 255, - "name": "name", - "required": true, + "name": "tungstenproviderport", + "required": false, "type": "string" }, { @@ -19416,16 +20843,23 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric provider port", + "description": "Tungsten-Fabric provider hostname", "length": 255, - "name": "tungstenproviderport", - "required": false, + "name": "tungstenproviderhostname", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric provider hostname", + "description": "Tungsten-Fabric provider gateway", "length": 255, - "name": "tungstenproviderhostname", + "name": "tungstengateway", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider name", + "length": 255, + "name": "name", "required": true, "type": "string" }, @@ -19440,114 +20874,82 @@ "related": "listTungstenFabricProviders", "response": [ { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "Tungsten-Fabric provider name", "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, - {}, { "description": "Tungsten-Fabric provider vrouter port", "name": "tungstenprovidervrouterport", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - { - "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", - "type": "string" - }, { "description": "Tungsten-Fabric provider gateway", "name": "tungstengateway", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Enables HA cluster-wide", + "description": "Reboots a virtual machine.", "isasync": true, - "name": "enableHAForCluster", + "name": "rebootVirtualMachine", "params": [ { - "description": "ID of the cluster", + "description": "The ID of the virtual machine", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.11" - }, - { - "description": "Reboots a virtual machine.", - "isasync": true, - "name": "rebootVirtualMachine", - "params": [ { "description": "Force reboot the VM (VM is Stopped and then Started)", "length": 255, @@ -19563,247 +20965,367 @@ "required": false, "since": "4.15.0.0", "type": "boolean" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,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", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the 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 account associated with the virtual machine", - "name": "account", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "VNF details", + "name": "vnfdetails", + "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": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name of the group", + "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 name of the security group", - "name": "name", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", - "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "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 account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -19814,38 +21336,48 @@ "name": "account", "type": "string" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -19854,198 +21386,164 @@ "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 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 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", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, - {}, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the 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 ID of 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 nics associated with vm", "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { "description": "the traffic type of the nic", @@ -20053,23 +21551,28 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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" }, { @@ -20078,48 +21581,53 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -20128,18 +21636,23 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -20148,9 +21661,9 @@ "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "true if nic is default, false otherwise", @@ -20158,301 +21671,198 @@ "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "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 user's ID who deployed the virtual machine", + "name": "userid", "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the project name of the vm", + "name": "project", "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "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", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "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 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 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 ID of 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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -20461,64 +21871,68 @@ "type": "map" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the 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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, - {}, { - "description": "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 name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -20527,9 +21941,9 @@ "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -20537,65 +21951,102 @@ "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "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", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "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. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - } - ] + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + } + ] }, { - "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", - "isasync": false, - "name": "addVirtualMachinesToKubernetesCluster", + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", "params": [ { - "description": "the IDs of the VMs to add to the cluster", + "description": "ID of the cluster", "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, - "type": "list" + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "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": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "isasync": false, + "name": "addVirtualMachinesToKubernetesCluster", + "params": [ { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -20604,6 +22055,14 @@ "required": true, "type": "uuid" }, + { + "description": "the IDs of the VMs to add to the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "list" + }, { "description": "Is control node or not? Defaults to false.", "length": 255, @@ -20613,26 +22072,26 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], @@ -20643,28 +22102,6 @@ "isasync": true, "name": "createLoadBalancerRule", "params": [ - { - "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": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the public port from where the network traffic will be load balanced from", "length": 255, @@ -20673,18 +22110,12 @@ "type": "integer" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, - "type": "string" - }, - { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "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": "protocol", + "name": "cidrlist", "required": false, - "type": "string" + "since": "4.18.0.0", + "type": "list" }, { "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", @@ -20693,6 +22124,13 @@ "required": false, "type": "boolean" }, + { + "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, @@ -20701,13 +22139,6 @@ "required": false, "type": "uuid" }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "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", "length": 255, @@ -20717,12 +22148,18 @@ "type": "uuid" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", @@ -20739,6 +22176,13 @@ "required": true, "type": "integer" }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, + "type": "string" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -20746,39 +22190,33 @@ "required": false, "since": "4.4", "type": "boolean" - } - ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", - "response": [ - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" }, { - "description": "the 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": "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": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "name of the load balancer rule", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, - {}, + } + ], + "related": "listLoadBalancerRules,updateLoadBalancerRule", + "response": [ { - "description": "the public ip address", - "name": "publicip", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { @@ -20787,18 +22225,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -20806,13 +22234,18 @@ "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": "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", "type": "string" }, { @@ -20821,8 +22254,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -20836,41 +22274,37 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "list" }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + {}, { "description": "the private port", "name": "privateport", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -20884,13 +22318,13 @@ "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { @@ -20898,27 +22332,52 @@ "name": "fordisplay", "type": "boolean" }, - {}, { "description": "the public port", "name": "publicport", "type": "string" }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "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 load balancer rule belongs to", - "name": "zonename", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { @@ -20927,126 +22386,97 @@ "name": "listTungstenFabricLogicalRouter", "params": [ { - "description": "the uuid of Tungsten-Fabric network", + "description": "the uuid of Tungsten-Fabric logical router", "length": 255, - "name": "networkuuid", + "name": "logicalrouteruuid", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "page", + "name": "networkuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "", "length": 255, - "name": "logicalrouteruuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "createTungstenFabricLogicalRouter,addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "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 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 logical router uuid", "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" } ] }, { - "description": "Lists backup offerings", + "description": "Import vSphere storage policies", "isasync": false, - "name": "listBackupOfferings", + "name": "importVsphereStoragePolicies", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "The backup offering ID", - "length": 255, - "name": "id", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "The zone ID", + "description": "ID of the zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -21054,18 +22484,16 @@ "type": "uuid" } ], - "related": "listBackupProviderOfferings,importBackupOffering,updateBackupOffering", + "related": "listVsphereStoragePolicies", "response": [ { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "the ID of the Storage Policy", + "name": "id", + "type": "string" }, - {}, - {}, { - "description": "zone ID", - "name": "zoneid", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, { @@ -21074,42 +22502,28 @@ "type": "integer" }, { - "description": "name for the backup offering", - "name": "name", - "type": "string" - }, - { - "description": "description for the backup offering", + "description": "the description of the Storage Policy", "name": "description", "type": "string" }, - { - "description": "external ID on the provider side", - "name": "externalid", - "type": "string" - }, - { - "description": "ID of the backup offering", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", + "type": "string" }, + {}, + {}, { - "description": "zone name", - "name": "zonename", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" } - ], - "since": "4.14.0" + ] }, { "description": "Adds a guest OS name to hypervisor OS name mapping", @@ -21117,17 +22531,10 @@ "name": "addGuestOsMapping", "params": [ { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", - "length": 255, - "name": "hypervisorversion", - "required": true, - "type": "string" - }, - { - "description": "OS name specific to the hypervisor", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "osnameforhypervisor", - "required": true, + "name": "osdisplayname", + "required": false, "type": "string" }, { @@ -21138,6 +22545,13 @@ "required": false, "type": "uuid" }, + { + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, { "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", "length": 255, @@ -21146,6 +22560,13 @@ "since": "4.19.0", "type": "boolean" }, + { + "description": "OS name specific to the hypervisor", + "length": 255, + "name": "osnameforhypervisor", + "required": true, + "type": "string" + }, { "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", "length": 255, @@ -21155,41 +22576,39 @@ "type": "boolean" }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", - "length": 255, - "name": "osdisplayname", - "required": false, - "type": "string" - }, - { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", "length": 255, - "name": "hypervisor", + "name": "hypervisorversion", "required": true, "type": "string" } ], "related": "updateGuestOsMapping", "response": [ + {}, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "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", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, {}, @@ -21199,24 +22618,19 @@ "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "the hypervisor", + "name": "hypervisor", "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": "version of the hypervisor for mapping", "name": "hypervisorversion", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.4.0" @@ -21243,25 +22657,24 @@ "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "the operation result", + "name": "status", "type": "boolean" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, - {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the out-of-band management interface powerState of the host", @@ -21269,1062 +22682,1017 @@ "type": "powerstate" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, - {}, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result description", + "name": "description", "type": "string" }, + {}, { "description": "the ID of the host", "name": "hostid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" } ], "since": "4.9.0" }, { - "description": "Updates a network offering.", + "description": "List all public, private, and privileged VNF templates.", "isasync": false, - "name": "updateNetworkOffering", + "name": "listVnfTemplates", "params": [ { - "description": "the display text of the network offering", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "displaytext", + "name": "details", "required": false, - "type": "string" + "since": "4.15", + "type": "list" }, { - "description": "update state for the network offering", + "description": "the type of the template", "length": 255, - "name": "state", + "name": "templatetype", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "list templates by zoneId", "length": 255, - "name": "domainid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "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.", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "keepaliveenabled", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "sort key of the network offering, integer", + "description": "", "length": 255, - "name": "sortkey", + "name": "page", "required": false, "type": "integer" }, { - "description": "the tags for the network offering.", - "length": 4096, + "description": "list datadisk templates by parent template id", + "length": 255, + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, "name": "tags", "required": false, + "type": "map" + }, + { + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "length": 255, + "name": "templatefilter", + "required": true, + "type": "string" + }, + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "maxconnections", + "name": "isvnf", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the name of the network offering", + "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 template name", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the id of the network offering", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, - "since": "4.13", "type": "string" }, { - "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "availability", + "name": "ids", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" + "since": "4.9", + "type": "list" + }, + { + "description": "If set to true, list only unique templates across zones", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "show removed templates as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "createNetworkOffering,listNetworkOfferings", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the list of supported services", - "name": "service", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "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 featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "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": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "additional key/value details tied with network offering", + "description": "additional key/value details tied with template", "name": "details", "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "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 template ID", + "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", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "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": "Create VM backup", - "isasync": true, - "name": "createBackup", - "params": [ + }, { - "description": "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,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" - } - ], - "response": [ + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" } ], - "since": "4.14.0" + "since": "4.19.0" }, { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", + "description": "Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.", + "isasync": true, + "name": "deployVnfAppliance", "params": [ { - "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)", + "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": "tags", + "name": "securitygroupnames", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, - "type": "map" + "type": "list" }, { - "description": "list ipv6 firewall rules by network ID", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "networkid", + "name": "networkids", "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "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 start vm after creating; defaulted to true if not specified", "length": 255, - "name": "listall", + "name": "startvm", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "overridediskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", "length": 255, - "name": "isrecursive", + "name": "iptonetworklist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "fordisplay", + "name": "dynamicscalingenabled", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "pagesize", + "name": "password", "required": false, - "type": "integer" + "since": "4.19.0.0", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "bootmode", "required": false, - "type": "uuid" + "since": "4.14.0.0", + "type": "string" }, { - "description": "", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "page", + "name": "nicmultiqueuenumber", "required": false, + "since": "4.18", "type": "integer" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", "length": 255, - "name": "traffictype", + "name": "vnfcidrlist", "required": false, - "type": "string" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - {}, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], "type": "list" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "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 VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - } - ] - }, - { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", - "params": [ - { - "description": "Force stop the VM. The caller knows the VM is stopped.", + "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", "length": 255, - "name": "forced", + "name": "vnfconfiguremanagement", "required": false, "type": "boolean" }, { - "description": "The ID of the system virtual machine", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "name": "details", + "required": false, + "since": "4.3", + "type": "map" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "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.", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "since": "4.11", + "type": "map" }, { - "description": "the name of the system VM", + "description": "host name for the virtual machine", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "length": 255, + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "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 ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" }, { - "description": "the 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 Userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", + "required": false, "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" }, { - "description": "the Zone ID for the system VM", + "description": "availability zone for the virtual machine", + "length": 255, "name": "zoneid", - "type": "string" + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "length": 255, + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "used to specify the vApp properties.", + "length": 255, + "name": "properties", + "required": false, + "since": "4.15", + "type": "map" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.2", "type": "boolean" }, - {}, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, - { - "description": "the ID of the system VM", - "name": "id", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "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,updateSecurityGroup", + "required": false, + "type": "list" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes an egress firewall rule", - "isasync": true, - "name": "deleteEgressFirewallRule", - "params": [ - { - "description": "the ID of the firewall rule", + "description": "Controls specific policies on IO", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "iodriverpolicy", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Updates a VPC", - "isasync": true, - "name": "updateVPC", - "params": [ - { - "description": "an optional field, whether to the display the vpc to the end user or not", + "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": "fordisplay", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "the id of the VPC", + "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": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "iothreadsenabled", + "required": false, + "type": "boolean" }, { - "description": "the display text of the VPC", + "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": "displaytext", + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "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": "customid", + "name": "rootdisksize", "required": false, "since": "4.4", - "type": "string" + "type": "long" }, { - "description": "the name of the VPC", + "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "sourcenatipaddress", + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", + "length": 1048576, + "name": "userdata", "required": false, - "since": "4.19", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" } ], - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the id of the VPC", - "name": "id", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "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": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, + {}, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "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", @@ -22332,958 +23700,1141 @@ "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the owner of the VPC", + "description": "the account associated with the virtual machine", "name": "account", "type": "string" }, { - "description": "the date this VPC was created", + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the list of supported services", - "name": "service", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the service name", - "name": "name", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "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 destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { - "description": "the capability value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - {}, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - {} - ] - }, - { - "description": "Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password", - "isasync": true, - "name": "changeOutOfBandManagementPassword", - "params": [ + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", - "length": 255, - "name": "password", - "required": false, + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project 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": "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": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "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,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", - "response": [ + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "set" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, - {}, { - "description": "the operation result description", - "name": "description", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "List VM Schedules.", - "isasync": false, - "name": "listVMSchedule", - "params": [ + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "ID of VM schedule", - "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "Action taken by schedule", - "length": 255, - "name": "action", - "required": false, + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "ID of VM schedule", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" - } - ], - "related": "createVMSchedule,updateVMSchedule", - "response": [ + }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "VM schedule is enabled", - "name": "enabled", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", + "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": "Timezone of the schedule", - "name": "timezone", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, + {}, { - "description": "Description of VM schedule", - "name": "description", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "List resource detail(s)", - "isasync": false, - "name": "listResourceDetails", - "params": [ + }, { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "list by key", - "length": 255, - "name": "key", - "required": false, + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "Name of 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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + {}, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "list by key, value. Needs to be passed only along with key", - "length": 255, - "name": "value", - "required": false, - "since": "4.4", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" - } - ], - "related": "listTags", - "response": [ + }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" } ], - "since": "4.2" + "since": "4.19.0" }, { - "description": "Attempts to live patch systemVMs - CPVM, SSVM ", - "isasync": true, - "name": "patchSystemVm", + "description": "Updates a network offering.", + "isasync": false, + "name": "updateNetworkOffering", "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", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "update state for the network offering", "length": 255, - "name": "forced", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "patches systemVM - CPVM/SSVM with the specified ID", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "domainid", "required": false, - "type": "uuid" - } - ], - "response": [ - {}, - {}, + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "sort key of the network offering, integer", + "length": 255, + "name": "sortkey", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.17.0" - }, - { - "description": "Dedicate an existing cluster", - "isasync": true, - "name": "dedicateCluster", - "params": [ + "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", + "length": 255, + "name": "availability", + "required": false, + "type": "string" + }, { - "description": "the ID of the Cluster", + "description": "the id of the network offering", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, "type": "uuid" }, { - "description": "the ID of the containing domain", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "name": "keepaliveenabled", + "required": false, + "type": "boolean" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "the name of the network offering", "length": 255, - "name": "account", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", "required": false, "type": "string" } ], - "related": "listDedicatedClusters", + "related": "createNetworkOffering,listNetworkOfferings", "response": [ + { + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, - {}, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the cluster", - "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 Account ID of the cluster", - "name": "accountid", - "type": "string" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + {}, + { + "description": "the tags for the network offering", + "name": "tags", "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": "Creates a network offering.", - "isasync": false, - "name": "createNetworkOffering", - "params": [ + {}, { - "description": "the service offering ID used by virtual router provider", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "services supported by the network offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "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", - "length": 255, - "name": "egressdefaultpolicy", - "required": false, - "type": "boolean" - }, - { - "description": "true if network offering supports vlans", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" - }, - { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", - "length": 255, - "name": "traffictype", - "required": true, - "type": "string" - }, - { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", - "length": 255, - "name": "serviceproviderlist", - "required": false, - "type": "map" - }, - { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "list" - }, - { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", - "length": 255, - "name": "details", - "required": false, - "since": "4.2.0", - "type": "map" - }, - { - "description": "guest type of the network offering: Shared or Isolated", - "length": 255, - "name": "guestiptype", - "required": true, - "type": "string" - }, - { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, - "type": "integer" - }, - { - "description": "true if network offering is meant to be used for VPC, false otherwise.", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" - }, - { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "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.", - "length": 255, - "name": "keepaliveenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if the network offering is IP conserve mode enabled", - "length": 255, - "name": "conservemode", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the network offering, defaults to the value of 'name'.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing zone(s), null for public offerings", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" - }, - { - "description": "the availability of network offering. Default value is Optional", - "length": 255, - "name": "availability", - "required": false, - "type": "string" - }, - { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" - }, - { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" - }, - { - "description": "desired service capabilities as part of network offering", - "length": 255, - "name": "servicecapabilitylist", - "required": false, - "type": "map" - }, - { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", - "length": 255, - "name": "ispersistent", - "required": false, + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, - { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", - "length": 255, - "name": "fortungsten", - "required": false, - "type": "boolean" - } - ], - "related": "listNetworkOfferings", - "response": [ { "description": "the name of the network offering", "name": "name", "type": "string" }, - { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" - }, - { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" - }, { "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "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 the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "data transfer rate in megabits per second allowed.", @@ -23291,110 +24842,32 @@ "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": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, { "description": "true if network offering supports network that span multiple zones", "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, - {}, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, { "description": "the service 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": "the physical network this belongs to", @@ -23402,8 +24875,13 @@ "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 provider name", + "name": "name", "type": "string" }, { @@ -23417,13 +24895,30 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" }, { - "description": "the provider name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" } ], @@ -23438,199 +24933,188 @@ "type": "list" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "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" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "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 network offering was created", - "name": "created", - "type": "date" + "description": "availability of the network offering", + "name": "availability", + "type": "string" }, - {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the id of the network offering", - "name": "id", + "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 can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "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" } - ], - "since": "3.0.0" + ] }, { - "description": "Creates an IP forwarding rule", - "isasync": true, - "name": "createIpForwardingRule", + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", "params": [ { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "description": "", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the start port for the rule", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "startport", - "required": true, - "type": "integer" + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the end port for the rule", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "endport", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, "type": "integer" }, { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "openfirewall", + "name": "fordisplay", "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.", + "description": "list ipv6 firewall rules by network ID", "length": 255, - "name": "cidrlist", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "list" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "response": [ - {}, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "type": "uuid" }, { - "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 vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": false, + "type": "uuid" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" - }, + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "response": [ { "description": "the VM ID for the port forwarding rule", "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the 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 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -23639,13 +25123,13 @@ "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 account associated with the tag", + "name": "account", "type": "string" }, { @@ -23654,13 +25138,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -23674,561 +25158,451 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" - } - ] - }, - { - "description": "Lists volume metrics", - "isasync": false, - "name": "listVolumesMetrics", - "params": [ - { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "listsystemvms", - "required": false, - "since": "4.18", - "type": "boolean" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvolume", - "required": false, - "since": "4.4", - "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", - "length": 255, + "description": "the state of the rule", "name": "state", - "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": "list volumes by disk offering", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "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 ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "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 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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "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": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + } + ] + }, + { + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", + "params": [ { - "description": "the ID of the virtual machine", + "description": "The ID of the system 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, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "required": true, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, - "name": "listall", + "name": "forced", "required": false, "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the status of the volume", - "name": "status", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the path of the volume", - "name": "path", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "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 domain associated with the disk volume", - "name": "domain", + "description": "the private IP address for the system VM", + "name": "privateip", "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 public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, + {}, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "pod name of the volume", + "description": "the Pod name for the system VM", "name": "podname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, - {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "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 boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", "name": "jobstatus", "type": "integer" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", + "description": "the last disconnected date of host", + "name": "disconnected", "type": "date" - }, + } + ] + }, + { + "description": "Deletes an egress firewall rule", + "isasync": true, + "name": "deleteEgressFirewallRule", + "params": [ { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Updates a VPC", + "isasync": true, + "name": "updateVPC", + "params": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "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": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field, whether to the display the vpc to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the id of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { - "description": "disk size in GiB", - "name": "sizegb", - "type": "string" + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "name of the virtual machine", - "name": "vmname", + "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 project name of the vpn", - "name": "project", + "description": "the name of the VPC", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the display text of the VPC", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" - }, + } + ], + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -24237,382 +25611,503 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "set" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists the network Interfaces of elastistor", - "isasync": false, - "name": "listElastistorInterface", - "params": [ + "type": "list" + }, + {}, { - "description": "controller id", - "length": 255, - "name": "controllerid", - "required": false, + "description": "the cidr the VPC", + "name": "cidr", "type": "string" - } - ], - "related": "listElastistorVolume", - "response": [ + }, { - "description": "deduplication", - "name": "deduplication", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "syncronization", - "name": "sync", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, {}, { - "description": "compression", - "name": "compression", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the volume", + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the id of the VPC", "name": "id", "type": "string" }, { - "description": "the name of the volume", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the name of the VPC", "name": "name", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "graceallowed", - "name": "graceallowed", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" - } - ] - }, - { - "description": "Lists all possible details and their options for a resource type such as a VM or a template", - "isasync": false, - "name": "listDetailOptions", - "params": [ + }, { - "description": "the UUID of the resource (optional)", - "length": 255, - "name": "resourceid", - "required": false, + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the resource type such as UserVm, Template etc.", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the owner of the VPC", + "name": "account", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Map of all possible details and their possible list of values", - "name": "details", - "type": "map" + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the VPC", + "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" - } - ], - "since": "4.13" - }, - { - "description": "Lists SSL certificates", - "isasync": false, - "name": "listSslCerts", - "params": [ + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { - "description": "ID of SSL certificate", - "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", - "required": false, - "type": "uuid" + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" }, { - "description": "Account ID", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "Load balancer rule ID", + "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": "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": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": false, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, "type": "uuid" }, { - "description": "Project that owns the SSL certificate", + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "password", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "uploadSslCert", + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", "response": [ - {}, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "certificate", - "name": "certificate", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, - {}, { - "description": "the project id of the certificate", - "name": "projectid", - "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": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "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", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, + {}, + {}, { - "description": "name", - "name": "name", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the ID of the host", + "name": "hostid", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Create a quota statement", + "description": "List VM Schedules.", "isasync": false, - "name": "quotaStatement", + "name": "listVMSchedule", "params": [ { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "ID of VM schedule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "required": false, "type": "uuid" }, { - "description": "List quota usage records for the specified usage type", + "description": "Action taken by schedule", "length": 255, - "name": "type", + "name": "action", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", + "description": "List by keyword", "length": 255, - "name": "startdate", - "required": true, - "type": "date" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "enddate", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, - "type": "date" + "type": "uuid" }, { - "description": "Optional, Account Id for which statement needs to be generated", + "description": "", "length": 255, - "name": "account", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "List usage records for the specified account", + "description": "", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "ID of VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], - "related": "quotaBalance", + "related": "createVMSchedule,updateVMSchedule", "response": [ - {}, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { - "description": "usage unit", - "name": "unit", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Action", + "name": "action", + "type": "action" }, { - "description": "account name", - "name": "account", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, + {}, { - "description": "account id", - "name": "accountid", - "type": "long" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "usage type name", - "name": "name", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "usage type", - "name": "type", - "type": "int" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, { - "description": "domain id", - "name": "domain", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" } ], - "since": "4.7.0" + "since": "4.19.0" }, { - "description": "List private gateways", + "description": "List resource detail(s)", "isasync": false, - "name": "listPrivateGateways", + "name": "listResourceDetails", "params": [ { - "description": "list gateways by state", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list gateways by vpc", + "description": "list by key", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "key", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -24622,605 +26117,790 @@ "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "page", + "name": "value", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "list private gateway by id", + "description": "if set to true, only details marked with display=true, are returned. False by default", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.3", + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list gateways by vlan", + "description": "", "length": 255, - "name": "vlan", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list by resource id", "length": 255, - "name": "listall", + "name": "resourceid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by resource type", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "name": "resourcetype", + "required": true, + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list gateways by ip address", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ipaddress", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "createPrivateGateway,createPrivateGateway", + "related": "listTags", "response": [ { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, {}, + {}, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the gateway", - "name": "gateway", - "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 private gateway", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" + } + ], + "since": "4.2" + }, + { + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "isasync": true, + "name": "patchSystemVm", + "params": [ + { + "description": "patches systemVM - CPVM/SSVM with the specified ID", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "uuid" }, + { + "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "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": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.17.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 physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listDedicatedClusters", + "response": [ + { + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, + {}, + {}, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" } ] }, { - "description": "Update the default Ip of a VM Nic", - "isasync": true, - "name": "updateVmNicIp", + "description": "Creates a network offering.", + "isasync": false, + "name": "createNetworkOffering", "params": [ { - "description": "the ID of the nic to which you want to assign private IP", + "description": "true if network offering supports vlans", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "specifyvlan", + "required": false, + "type": "boolean" + }, + { + "description": "desired service capabilities as part of network offering", + "length": 255, + "name": "servicecapabilitylist", + "required": false, + "type": "map" + }, + { + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" + }, + { + "description": "the display text of the network offering, defaults to the value of 'name'.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "length": 255, + "name": "fortungsten", + "required": false, + "type": "boolean" + }, + { + "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "length": 255, + "name": "availability", + "required": false, + "type": "string" + }, + { + "description": "true if the network offering is IP conserve mode enabled", + "length": 255, + "name": "conservemode", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" + }, + { + "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 ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", "required": true, + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" + }, + { + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "length": 255, + "name": "details", + "required": false, + "since": "4.2.0", + "type": "map" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" + }, + { + "description": "the service offering ID used by virtual router provider", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, "type": "uuid" }, { - "description": "Secondary IP Address", + "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": "ipaddress", + "name": "keepaliveenabled", "required": false, - "type": "string" - } - ], - "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": [ + "type": "boolean" + }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "length": 255, + "name": "egressdefaultpolicy", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "list" + }, + { + "description": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" + }, + { + "description": "services supported by the network offering", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "length": 255, + "name": "ispersistent", + "required": false, + "type": "boolean" + } + ], + "related": "listNetworkOfferings", + "response": [ + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + {}, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "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": "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 name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "the tags for the network offering", + "name": "tags", + "type": "string" + }, + { + "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 traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], - "type": "set" + "type": "list" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the 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" + "type": "list" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "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 network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" }, {}, { - "description": "the list of resource tags associated", + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an IP forwarding rule", + "isasync": true, + "name": "createIpForwardingRule", + "params": [ + { + "description": "the end port for the rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "the start port for the rule", + "length": 255, + "name": "startport", + "required": true, + "type": "integer" + }, + { + "description": "the protocol for the rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "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 CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "response": [ + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -25232,13 +26912,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -25252,259 +26937,495 @@ "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" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, + {}, { - "description": "the state of the virtual machine", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the 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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + } + ] + }, + { + "description": "Lists volume metrics", + "isasync": false, + "name": "listVolumesMetrics", + "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the 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": "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 type of disk volume", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "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": "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 volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "the pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, "type": "map" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 speed of each vCPU", - "name": "cpuspeed", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the date when this virtual machine was created", + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "ID of the disk volume", + "name": "id", "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" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the 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": "the ID of the virtual machine", - "name": "id", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -25513,699 +27434,379 @@ "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "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 memory used by the VM in KiB", - "name": "memorykbs", + "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 id of userdata used for the VM", - "name": "userdataid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "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": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "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": "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" } - ] + ], + "since": "4.9.3" }, { - "description": "Updates load balancer stickiness policy", - "isasync": true, - "name": "updateLBStickinessPolicy", + "description": "Lists the network Interfaces of elastistor", + "isasync": false, + "name": "listElastistorInterface", "params": [ { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "id of lb stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "controller id", "length": 255, - "name": "customid", + "name": "controllerid", "required": false, - "since": "4.4", "type": "string" } ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "related": "listElastistorVolume", "response": [ { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "synchronization", + "name": "sync", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "compression", + "name": "compression", "type": "string" }, - {}, - { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ], - "type": "list" - }, { - "description": "the name of the Stickiness policy", + "description": "the name of the volume", "name": "name", "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 description of the Stickiness policy", - "name": "description", + "description": "deduplication", + "name": "deduplication", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "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 LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "4.4" + ] }, { - "description": "Lists all Pods.", + "description": "Lists all possible details and their options for a resource type such as a VM or a template", "isasync": false, - "name": "listPods", + "name": "listDetailOptions", "params": [ { - "description": "flag to display the capacity of the pods", + "description": "the UUID of the resource (optional)", "length": 255, - "name": "showcapacities", + "name": "resourceid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the resource type such as UserVm, Template etc.", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, + "name": "resourcetype", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "list pods by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list Pods by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Map of all possible details and their possible list of values", + "name": "details", + "type": "map" }, + {}, + {}, { - "description": "list Pods by ID", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.13" + }, + { + "description": "Lists SSL certificates", + "isasync": false, + "name": "listSslCerts", + "params": [ + { + "description": "Load balancer rule ID", "length": 255, - "name": "id", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, { - "description": "list Pods by name", + "description": "Account ID", "length": 255, - "name": "name", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "ID of SSL certificate", "length": 255, - "name": "page", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "updatePod,createManagementNetworkIpRange", + "related": "uploadSslCert", "response": [ { - "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": "name", + "name": "name", + "type": "string" }, + {}, { - "description": "the ID of the Pod", - "name": "id", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - } - ], + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", "type": "list" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the project name of the certificate", + "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": "SSL certificate ID", + "name": "id", + "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - } - ], - "type": "list" + "description": "certificate fingerprint", + "name": "fingerprint", + "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the name of the Pod", - "name": "name", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -26213,171 +27814,196 @@ "name": "jobid", "type": "string" }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - } + {} ] }, { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", + "description": "List private gateways", + "isasync": false, + "name": "listPrivateGateways", "params": [ { - "description": "the ID of the internal lb vm", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ + }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "list gateways by ip address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "list private gateway by id", + "length": 255, + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "list gateways by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, - {}, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list gateways by vpc", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "list gateways by vlan", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "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": "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" + } + ], + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "response": [ + { + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, - {}, { - "description": "the host ID for the router", - "name": "hostid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, + {}, { - "description": "the id of the router", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "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": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { @@ -26386,1125 +28012,1249 @@ "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, + {} + ] + }, + { + "description": "Update the default Ip of a VM Nic", + "isasync": true, + "name": "updateVmNicIp", + "params": [ { - "description": "the account associated with the router", - "name": "account", + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the ID of the nic to which you want to assign private IP", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + {}, { - "description": "the version of template", - "name": "version", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + {}, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the 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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the domain associated with the router", - "name": "domain", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of 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 corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the name of the virtual machine", + "name": "name", "type": "string" - } - ] - }, - { - "description": "Updates a disk offering.", - "isasync": false, - "name": "updateDiskOffering", - "params": [ - { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "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, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "since": "4.15", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "since": "4.15", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the cache mode to use for this disk offering", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.15", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "updates name of the disk offering with this value", - "length": 255, - "name": "name", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "sort key of the disk offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "since": "4.15", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "since": "4.15", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", - "length": 255, - "name": "tags", - "required": false, - "since": "4.15", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "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", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "required": false, - "since": "4.15", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "since": "4.15", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, - "since": "4.15", - "type": "long" - } - ], - "related": "createDiskOffering,listDiskOfferings", - "response": [ - { - "description": "the date this disk offering was created", + "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": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" - }, - { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, - {}, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "State of the Service from LB rule", + "name": "servicestate", "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 zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, + {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "unique ID of the disk offering", + "description": "the ID of the virtual machine", "name": "id", "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 affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" - } - ] - }, - { - "description": "delete Tungsten-Fabric address group", - "isasync": true, - "name": "deleteTungstenFabricAddressGroup", - "params": [ + }, { - "description": "the uuid of Tungsten-Fabric address group", - "length": 255, - "name": "addressgroupuuid", - "required": true, + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists all quota tariff plans", - "isasync": false, - "name": "quotaTariffList", - "params": [ - { - "description": "False will list only not removed quota tariffs. If set to True, we will list all, including the removed ones. The default is false.", - "length": 255, - "name": "listall", - "required": false, - "since": "4.18.0.0", - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "The start date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2021-11-03.", - "length": 255, - "name": "enddate", - "required": false, - "since": "4.18.0.0", - "type": "date" - }, - { - "description": "Usage type of the resource", - "length": 255, - "name": "usagetype", - "required": false, - "type": "integer" - }, - { - "description": "The name of the quota tariff.", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0.0", - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "quotaTariffUpdate,quotaTariffCreate", - "response": [ - { - "description": "currency", - "name": "currency", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name", - "name": "name", - "type": "string" - }, - { - "description": "usageType", - "name": "usageType", - "type": "int" - }, - { - "description": "uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "description", - "name": "description", - "type": "string" - }, - { - "description": "usageDiscriminator", - "name": "usageDiscriminator", - "type": "string" - }, - { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" - }, - {}, - { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + } + ], + "type": "set" }, { - "description": "usageUnit", - "name": "usageUnit", + "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", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "usageName", - "name": "usageName", - "type": "string" - }, - {} - ], - "since": "4.7.0" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + } + ] }, { - "description": "Stops a running CloudManaged Kubernetes cluster", + "description": "Updates load balancer stickiness policy", "isasync": true, - "name": "stopKubernetesCluster", + "name": "updateLBStickinessPolicy", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "an optional field, whether to the display the policy to the end user or not", "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": "true if operation is executed successfully", - "name": "success", + "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", - "isasync": false, - "name": "removeVirtualMachinesFromKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", + "description": "id of lb stickiness policy", "length": 255, "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "keyword", + "name": "customid", "required": false, + "since": "4.4", "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the IDs of the VMs to remove from the cluster", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,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": "list" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "", + "related": "createLBStickinessPolicy,listLBStickinessPolicies", "response": [ { - "description": "the id of the Kubernetes cluster", - "name": "id", - "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 domain of the Stickiness policy", + "name": "domain", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Adds account to a project", - "isasync": true, - "name": "addAccountToProject", - "params": [ { - "description": "name of the account to be added to the project", - "length": 255, - "name": "account", - "required": false, + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": "email to which invitation to the project is going to be sent", - "length": 255, - "name": "email", - "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" + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + } + ], + "type": "list" }, { - "description": "ID of the project to add the account to", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", - "length": 255, - "name": "roletype", - "required": false, + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" - } - ], - "response": [ - {}, + }, { - "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 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 name of the Stickiness policy", + "name": "name", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "lists snapshot by snapshot ID", + "description": "list Pods by ID", "length": 255, "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "valid values are MANUAL or RECURRING.", - "length": 255, - "name": "snapshottype", - "required": false, - "type": "string" - }, - { - "description": "lists snapshot by snapshot name", + "description": "list Pods by name", "length": 255, "name": "name", "required": false, "type": "string" }, { - "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 by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -27514,15 +29264,7 @@ "type": "integer" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "type": "uuid" - }, - { - "description": "list snapshots by zone id", + "description": "list Pods by Zone ID", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -27530,78 +29272,50 @@ "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.", + "description": "flag to display the capacity of the pods", "length": 255, - "name": "isrecursive", + "name": "showcapacities", "required": false, "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List resources by tags (key/value pairs)", + "description": "list pods by allocation state", "length": 255, - "name": "tags", + "name": "allocationstate", "required": false, - "type": "map" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" } ], - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", + "related": "updatePod,createManagementNetworkIpRange", "response": [ { - "description": "name of the disk volume", - "name": "volumename", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, + {}, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "name of the snapshot", + "description": "the name of the Pod", "name": "name", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "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", @@ -27609,1721 +29323,1626 @@ "type": "integer" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + } + ], + "type": "list" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, - {}, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, - {}, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the Zone name of the Pod", + "name": "zonename", "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 if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "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 project name of the snapshot", - "name": "project", + "description": "the netmask of the Pod", + "name": "netmask", "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", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "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", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster name", + "name": "clustername", "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], - "type": "set" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - } - ] - }, - { - "description": "delete Tungsten-Fabric logical router", - "isasync": true, - "name": "deleteTungstenFabricLogicalRouter", - "params": [ - { - "description": "the uuid of Tungsten-Fabric logical router", - "length": 255, - "name": "logicalrouteruuid", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "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" + "type": "list" } ] }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the name of the router", + "name": "name", "type": "string" }, - {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, - {}, - { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, { - "description": "the owner", - "name": "account", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "the project id", - "name": "projectid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the project name", - "name": "project", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the domain ID associated with the router", + "name": "domainid", "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": "Lists Kubernetes clusters", - "isasync": false, - "name": "listKubernetesClusters", - "params": [ - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", - "length": 255, - "name": "name", - "required": false, + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "type of the cluster: CloudManaged, ExternalManaged", - "length": 255, - "name": "clustertype", - "required": false, - "since": "4.19.0", - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + } + ], + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "state of the Kubernetes cluster", - "length": 255, - "name": "state", - "required": false, + "description": "the public IP address for the router", + "name": "publicip", "type": "string" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "response": [ - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "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 memory the Kubernetes cluster", - "name": "memory", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, + {}, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", + "description": "the date and time the router was created", "name": "created", "type": "date" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, + {}, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, - {}, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "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": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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 state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", + "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the second DNS for the router", + "name": "dns2", "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": "bytes write rate of the disk offering", "length": 255, - "name": "account", + "name": "byteswriterate", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "the domain ID associated with the keypair", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "iopswriterate", "required": false, - "type": "uuid" + "since": "4.15", + "type": "long" }, { - "description": "the project associated with keypair", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "byteswriteratemax", "required": false, - "type": "uuid" + "since": "4.15", + "type": "long" }, { - "description": "Name of the keypair", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "updates name of the disk offering with this value", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" - } - ], - "response": [ - {}, + }, { - "description": "true if operation is executed successfully", - "name": "success", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the cache mode to use for this disk offering", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.15", + "type": "string" + }, + { + "description": "sort key of the disk offering, integer", + "length": 255, + "name": "sortkey", + "required": false, "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, - {} - ] - }, - { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "createAutoScaleVmGroup", - "params": [ { - "description": "the name of the autoscale vmgroup", + "description": "length (in seconds) of the burst", "length": 255, - "name": "name", + "name": "iopsreadratemaxlength", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "the ID of the load balancer rule", + "description": "ID of the disk offering", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "io requests read rate of the disk offering", "length": 255, - "name": "fordisplay", + "name": "iopsreadrate", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.15", + "type": "long" }, { - "description": "list of scaledown autoscale policies", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "bytesreadrate", + "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": "burst requests read rate of the disk offering", "length": 255, - "name": "minmembers", - "required": true, - "type": "integer" + "name": "iopsreadratemax", + "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 frequency in which the performance counters to be collected", + "description": "length (in seconds) of the burst", "length": 255, - "name": "interval", + "name": "byteswriteratemaxlength", "required": false, - "type": "integer" + "since": "4.15", + "type": "long" }, { - "description": "list of scaleup autoscale policies", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "tags", + "required": false, + "since": "4.15", + "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "maxmembers", - "required": true, - "type": "integer" + "name": "bytesreadratemax", + "required": false, + "since": "4.15", + "type": "long" } ], - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "related": "createDiskOffering,listDiskOfferings", "response": [ { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the account owning the vm group", - "name": "account", - "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 of the vm group", - "name": "domainid", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, - {}, { - "description": "the private port", - "name": "privateport", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "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 public ip address", - "name": "publicip", + "description": "unique ID of the disk offering", + "name": "id", "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 cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Searches LDAP based on the username attribute", - "isasync": false, - "name": "searchLdap", - "params": [ + }, { - "description": "query to search using", - "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", - "required": true, - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "listLdapUsers", - "response": [ + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, {}, { - "description": "The user's username", - "name": "username", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "The user's domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" }, { - "description": "The user's email", - "name": "email", + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" + } + ] + }, + { + "description": "delete Tungsten-Fabric address group", + "isasync": true, + "name": "deleteTungstenFabricAddressGroup", + "params": [ + { + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": true, "type": "string" }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "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 lastname", - "name": "lastname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} - ], - "since": "4.2.0" + ] }, { - "description": "Returs the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown", - "isasync": false, - "name": "readyForShutdown", + "description": "Stops a running CloudManaged Kubernetes cluster", + "isasync": true, + "name": "stopKubernetesCluster", "params": [ { - "description": "the uuid of the management server", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": false, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, "type": "uuid" } ], - "related": "prepareForShutdown,triggerShutdown", "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 number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - }, - {}, - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" - } - ], - "since": "4.19.0" + {} + ] }, { - "description": "add a baremetal ping pxe server", - "isasync": true, - "name": "addBaremetalPxePingServer", + "description": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "isasync": false, + "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ { - "description": "PING storage server ip", + "description": "", "length": 255, - "name": "pingstorageserverip", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "type of pxe device", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "pxeservertype", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach external pxe device", + "description": "the IDs of the VMs to remove from the cluster", "length": 255, - "name": "password", + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, - "type": "string" + "type": "list" }, { - "description": "Username of PING storage server", + "description": "List by keyword", "length": 255, - "name": "pingcifsusername", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Pod Id", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Password of PING storage server", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Adds account to a project", + "isasync": true, + "name": "addAccountToProject", + "params": [ + { + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", "length": 255, - "name": "pingcifspassword", + "name": "roletype", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "ID of the project role", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": false, "type": "uuid" }, { - "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": "URL of the external pxe device", + "description": "name of the account to be added to the project", "length": 255, - "name": "url", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "Root directory on PING storage server", + "description": "email to which invitation to the project is going to be sent", "length": 255, - "name": "pingdir", - "required": true, + "name": "email", + "required": false, "type": "string" } ], - "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "PING storage server ip", - "name": "pingstorageserverip", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" - }, - {}, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { - "description": "url", - "name": "url", - "type": "string" - }, - { - "description": "Root directory on PING storage server", - "name": "pingdir", - "type": "string" - } - ] - }, - { - "description": "Deletes a load balancer rule.", - "isasync": true, - "name": "deleteLoadBalancerRule", - "params": [ - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } - ] + }, + {}, + {} + ], + "since": "3.0.0" }, { - "description": "create Tungsten-Fabric logical router", - "isasync": true, - "name": "createTungstenFabricLogicalRouter", + "description": "Lists all available snapshots for the account.", + "isasync": false, + "name": "listSnapshots", "params": [ { - "description": "Tungsten-Fabric logical router name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the ID of zone", + "description": "ID of the image or image cache store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": false, + "since": "4.19", "type": "uuid" - } - ], - "related": "addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "length": 255, + "name": "locationtype", + "required": false, + "since": "4.19.0", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "description": "create Tungsten-Fabric firewall", - "isasync": true, - "name": "createTungstenFabricFirewallRule", - "params": [ - { - "description": "Tungsten-Fabric firewall rule destination address group uuid", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "destaddressgroupuuid", + "name": "account", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "direction", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "ID of the storage pool", "length": 255, - "name": "desttaguuid", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric destination network", + "description": "", "length": 255, - "name": "destnetworkuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "List by keyword", "length": 255, - "name": "firewallpolicyuuid", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric source network", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "srcnetworkuuid", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "Tungsten-Fabric firewall rule service group uuid", + "description": "If set to false, list templates across zones and their storages", "length": 255, - "name": "servicegroupuuid", - "required": true, - "type": "string" + "name": "showunique", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "srctaguuid", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Tungsten-Fabric firewall rule name", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "name", - "required": true, + "name": "snapshottype", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group uuid", + "description": "list snapshots by zone id", "length": 255, - "name": "srcaddressgroupuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Tungsten-Fabric firewall rule action", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "action", - "required": true, + "name": "intervaltype", + "required": false, "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "name": "ids", + "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "required": false, + "since": "4.9", + "type": "list" }, { - "description": "Tungsten-Fabric firewall rule tag type uuid", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "tagtypeuuid", + "name": "id", + "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "listTungstenFabricFirewallRule", + "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", + "description": "name of the snapshot", "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" - } - ] - }, - { - "description": "list portable IP ranges", - "isasync": false, - "name": "listPortableIpRanges", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "Id of a Region", - "length": 255, - "name": "regionid", - "required": false, - "type": "integer" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "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, - "type": "string" - }, - { - "description": "Id of the portable ip range", - "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", - "required": false, - "type": "uuid" - } - ], - "related": "createPortableIpRange", - "response": [ - { - "description": "portable IP range ID", - "name": "id", - "type": "string" - }, - { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "the status of the template", + "name": "status", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "virtualmachineid", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, {}, { - "description": "the 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 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": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" } - ], - "since": "4.4" + ] }, { - "description": "Updates network permissions.", - "isasync": false, - "name": "createNetworkPermissions", + "description": "delete Tungsten-Fabric logical router", + "isasync": true, + "name": "deleteTungstenFabricLogicalRouter", "params": [ { - "description": "the network ID", + "description": "the ID of zone", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "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 accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accounts", - "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.", + "description": "the uuid of Tungsten-Fabric logical router", "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "list" + "name": "logicalrouteruuid", + "required": true, + "type": "string" } ], "response": [ @@ -29349,580 +30968,427 @@ "name": "jobid", "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "Lists all configurations.", - "isasync": false, - "name": "listConfigurations", + "description": "Reset site to site vpn connection", + "isasync": true, + "name": "resetVpnConnection", "params": [ { - "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 ID of the Image Store to update the parameter value for corresponding image store", + "description": "an optional account for connection. Must be used with domainId.", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "id of vpn connection", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, + "name": "id", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "required": true, "type": "uuid" - }, + } + ], + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "response": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, + {}, { - "description": "lists configurations by category", - "length": 255, - "name": "category", - "required": false, + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "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": "lists configuration by subgroup name (primarily used for UI)", - "length": 255, - "name": "subgroup", - "required": false, - "since": "4.18.0", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "lists configuration by name", - "length": 255, - "name": "name", - "required": false, + "description": "the public IP address", + "name": "publicip", "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": "lists configuration by parent name (primarily used for UI)", - "length": 255, - "name": "parent", - "required": false, - "since": "4.18.0", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "State of vpn connection", + "name": "state", + "type": "string" }, + {}, { - "description": "lists configuration by group name (primarily used for UI)", - "length": 255, - "name": "group", - "required": false, - "since": "4.18.0", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" - } - ], - "related": "updateConfiguration", - "response": [ + }, { - "description": "the description of the configuration", - "name": "description", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the connection ID", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the group of the configuration", - "name": "group", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the name of the configuration", - "name": "name", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the display text of the configuration", - "name": "displaytext", - "type": "string" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" } ] }, { - "description": "Disables static rule for given IP address", + "description": "migrates resources from one secondary storage to destination image store", "isasync": true, - "name": "disableStaticNat", + "name": "migrateResourceToAnotherSecondaryStorage", "params": [ { - "description": "the public IP address ID for which static NAT feature is being disabled", + "description": "id of the image store from where the data is to be migrated", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "length": 255, + "name": "destpool", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Assigns secondary IP to NIC", - "isasync": true, - "name": "addIpToNic", - "params": [ { - "description": "Secondary IP Address", + "description": "id(s) of the templates to be migrated", "length": 255, - "name": "ipaddress", + "name": "templates", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" + "type": "list" }, { - "description": "the ID of the nic to which you want to assign private IP", + "description": "id(s) of the snapshots to be migrated", "length": 255, - "name": "nicid", - "related": "listNics", - "required": true, - "type": "uuid" + "name": "snapshots", + "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "required": false, + "type": "list" } ], - "related": "", + "related": "migrateSecondaryStorageData", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Secondary IP address", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "Response message from migration of secondary storage data objects", + "name": "message", "type": "string" }, { - "description": "the ID of the secondary private IP addr", - "name": "id", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, {}, - { - "description": "the ID of the network", - "name": "networkid", - "type": "string" - }, {}, { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Update the tariff plan for a resource", + "description": "Lists Kubernetes clusters", "isasync": false, - "name": "quotaTariffUpdate", + "name": "listKubernetesClusters", "params": [ { - "description": "Quota tariff's description. Inform empty to remove the description.", - "length": 65535, - "name": "description", + "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, - "since": "4.18.0.0", "type": "string" }, { - "description": "DEPRECATED. Integer value for the usage type of the resource", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "usagetype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "enddate", + "name": "listall", "required": false, - "since": "4.18.0.0", - "type": "date" + "type": "boolean" }, { - "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "The quota tariff value of the resource as per the default unit.", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "value", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, - "type": "double" + "type": "uuid" }, { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", - "length": 65535, - "name": "activationrule", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, - "since": "4.18.0.0", "type": "string" }, { - "description": "Quota tariff's name", - "length": 65535, - "name": "name", - "required": true, - "since": "4.18.0.0", - "type": "string" - } - ], - "related": "quotaTariffCreate", - "response": [ + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { - "description": "usageUnit", - "name": "usageUnit", + "description": "state of the Kubernetes cluster", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "type of the cluster: CloudManaged, ExternalManaged", + "length": 255, + "name": "clustertype", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", - "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": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "response": [ + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, - {}, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "description", - "name": "description", + "description": "the name of the Kubernetes cluster", + "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 network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "usageType", - "name": "usageType", - "type": "int" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "name", - "name": "name", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "usageName", - "name": "usageName", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "uuid", - "name": "uuid", - "type": "string" - } - ], - "since": "4.7.0" - }, - { - "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", - "isasync": true, - "name": "scaleKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - }, - { - "description": "Whether autoscaling is enabled for the cluster", - "length": 255, - "name": "autoscalingenabled", - "required": false, - "type": "boolean" - }, - { - "description": "Maximum number of worker nodes in the cluster", - "length": 255, - "name": "maxsize", - "required": false, - "type": "long" - }, - { - "description": "Minimum number of worker nodes in the cluster", - "length": 255, - "name": "minsize", - "required": false, - "type": "long" - }, - { - "description": "the ID of the service offering for the virtual machines in the cluster.", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "number of Kubernetes cluster nodes", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, - { - "description": "the IDs of the nodes to be removed", - "length": 255, - "name": "nodeids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "response": [ - { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" - }, - { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "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 Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - {}, { "description": "the name of the domain in which the Kubernetes cluster exists", "name": "domain", "type": "string" }, - { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" - }, - { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" - }, { "description": "the state of the Kubernetes cluster", "name": "state", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { @@ -29931,43 +31397,39 @@ "type": "integer" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "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 project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { @@ -29976,38 +31438,53 @@ "type": "long" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { "description": "Whether autoscaling is enabled for the cluster", "name": "autoscalingenabled", "type": "boolean" }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + }, { "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", "name": "masternodes", "type": "long" }, { - "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 name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { @@ -30015,459 +31492,331 @@ "name": "ipaddressid", "type": "string" }, + {} + ] + }, + { + "description": "Deletes a keypair by name", + "isasync": false, + "name": "deleteSSHKeyPair", + "params": [ { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the project associated with keypair", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "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 project name of the Kubernetes cluster", - "name": "project", + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "response": [ + {}, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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": "the ID of the NetScaler vm", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "Force stop the VM. The caller knows the VM is stopped.", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the name of the autoscale vmgroup", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "length": 255, + "name": "minmembers", + "required": true, + "type": "integer" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the frequency in which the performance counters to be collected", + "length": 255, + "name": "interval", + "required": false, + "type": "integer" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "the autoscale profile that contains information about the vms in the vm group.", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "an optional field, whether to the display the group to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "length": 255, + "name": "maxmembers", + "required": true, + "type": "integer" + } + ], + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "response": [ { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "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" - } - ], + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", "type": "list" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the id of the router", + "description": "the autoscale vm group ID", "name": "id", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, + {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "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 ID of the corresponding public network", - "name": "publicnetworkid", - "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 Pod name for the router", - "name": "podname", - "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 first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" - }, + } + ] + }, + { + "description": "Searches LDAP based on the username attribute", + "isasync": false, + "name": "searchLdap", + "params": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "query to search using", + "length": 255, + "name": "query", + "related": "searchLdap,listLdapUsers", + "required": true, "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "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": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "listLdapUsers", + "response": [ { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { @@ -30476,78 +31825,66 @@ "type": "integer" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", + "description": "The user's email", + "name": "email", "type": "string" }, + {}, + {}, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "The user's firstname", + "name": "firstname", "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 guest IP address for the router", - "name": "guestipaddress", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The user's domain", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, - {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The user's principle", + "name": "principal", "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" } - ] + ], + "since": "4.2.0" }, { - "description": "Delete a Ucs manager", + "description": "Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown", "isasync": false, - "name": "deleteUcsManager", + "name": "readyForShutdown", "params": [ { - "description": "ucs manager id", + "description": "the uuid of the management server", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, "type": "uuid" } ], + "related": "prepareForShutdown,triggerShutdown", "response": [ + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -30555,98 +31892,51 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "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": "Deletes a host.", - "isasync": false, - "name": "deleteHost", - "params": [ - { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" - }, - { - "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": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { - "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": "The id of the management server", + "name": "managementserverid", + "type": "long" } ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] + "since": "4.19.0" }, { - "description": "Deletes a vm group", - "isasync": false, - "name": "deleteInstanceGroup", + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", "params": [ { - "description": "the ID of the instance group", + "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" } ], "response": [ - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -30665,112 +31955,111 @@ ] }, { - "description": "deletes the resource icon from the specified resource(s)", - "isasync": false, - "name": "deleteResourceIcon", + "description": "add a baremetal ping pxe server", + "isasync": true, + "name": "addBaremetalPxePingServer", "params": [ { - "description": "list of resources to upload the icon/image for", + "description": "Pod Id", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "type of the resource", + "description": "Password of PING storage server", "length": 255, - "name": "resourcetype", - "required": true, + "name": "pingcifspassword", + "required": false, "type": "string" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, "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": "type of pxe device", + "length": 255, + "name": "pxeservertype", + "required": true, "type": "string" }, - {} - ], - "since": "4.16.0.0" - }, - { - "description": "Lists capabilities", - "isasync": false, - "name": "listCapabilities", - "params": [], - "related": "", - "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Username of PING storage server", + "length": 255, + "name": "pingcifsusername", + "required": false, "type": "string" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, + "type": "string" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, - {}, { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", - "type": "integer" + "description": "Root directory on PING storage server", + "length": 255, + "name": "pingdir", + "required": true, + "type": "string" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", - "type": "boolean" + "description": "URL of the external pxe device", + "length": 255, + "name": "url", + "required": true, + "type": "string" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" - }, + "description": "PING storage server ip", + "length": 255, + "name": "pingstorageserverip", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", - "type": "boolean" + "description": "Root directory on PING storage server", + "name": "pingdir", + "type": "string" }, { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" + "description": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" }, + {}, { - "description": "version of the cloud stack", - "name": "cloudstackversion", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -30780,283 +32069,297 @@ }, {}, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" - }, - { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "type": "boolean" - }, - { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "url", + "name": "url", + "type": "string" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", - "type": "boolean" + "description": "PING storage server ip", + "name": "pingstorageserverip", + "type": "string" }, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", - "type": "boolean" - }, + "description": "name of the provider", + "name": "provider", + "type": "string" + } + ] + }, + { + "description": "create Tungsten-Fabric logical router", + "isasync": true, + "name": "createTungstenFabricLogicalRouter", + "params": [ { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", - "type": "boolean" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", - "type": "boolean" + "description": "Tungsten-Fabric logical router name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", + "response": [ + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", - "type": "boolean" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" + "description": "Tungsten-Fabric logical router name", + "name": "name", + "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": "Tungsten-Fabric provider zone name", + "name": "zonename", + "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": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" } ] }, { - "description": "Release dedication of zone", + "description": "create Tungsten-Fabric firewall", "isasync": true, - "name": "releaseDedicatedZone", + "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "the ID of the Zone", + "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": "Tungsten-Fabric firewall rule direction", + "length": 255, + "name": "direction", + "required": true, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the sequence of Tungsten-Fabric firewall rule", + "length": 255, + "name": "sequence", + "required": true, "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": true, "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule action", + "length": 255, + "name": "action", + "required": true, "type": "string" - } - ] - }, - { - "description": "Updates traffic type of a physical network", - "isasync": true, - "name": "updateTrafficType", - "params": [ + }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "Tungsten-Fabric firewall rule destination tag uuid", "length": 255, - "name": "hypervnetworklabel", + "name": "desttaguuid", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "Tungsten-Fabric firewall rule name", "length": 255, - "name": "ovm3networklabel", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric source network", + "length": 255, + "name": "srcnetworkuuid", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "Tungsten-Fabric firewall rule source tag uuid", "length": 255, - "name": "xennetworklabel", + "name": "srctaguuid", "required": false, "type": "string" }, { - "description": "traffic type id", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", + "name": "tagtypeuuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule service group uuid", + "length": 255, + "name": "servicegroupuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "Tungsten-Fabric firewall rule source address group uuid", "length": 255, - "name": "kvmnetworklabel", + "name": "srcaddressgroupuuid", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "the uuid of Tungsten-Fabric destination network", "length": 255, - "name": "vmwarenetworklabel", + "name": "destnetworkuuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination address group uuid", + "length": 255, + "name": "destaddressgroupuuid", "required": false, "type": "string" } ], - "related": "addTrafficType", + "related": "listTungstenFabricFirewallRule", "response": [ {}, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, - {}, { - "description": "id of the network provider", - "name": "id", + "description": "Tungsten-Fabric firewall rule 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 firewall rule tag type", + "name": "tagtype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "List Conditions for VM auto scaling", - "isasync": false, - "name": "listConditions", - "params": [ - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" }, { - "description": "the ID of the policy", - "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "uuid" + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, + {}, { - "description": "ID of the Condition.", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "list portable IP ranges", + "isasync": false, + "name": "listPortableIpRanges", + "params": [ + { + "description": "Id of a Region", "length": 255, - "name": "id", - "related": "createCondition,listConditions", + "name": "regionid", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "Id of the portable ip range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, "type": "uuid" }, @@ -31068,168 +32371,222 @@ "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": "Counter-id of the condition.", + "description": "", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "createCondition", + "related": "createPortableIpRange", "response": [ + {}, { - "description": "the owner of the Condition.", - "name": "account", - "type": "string" - }, - { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" - }, - { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "portable IP range ID", + "name": "id", "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", + "response": [ + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "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 ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" + }, + { + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", + "type": "string" + }, + { + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" + } + ], + "type": "list" }, { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, {}, { - "description": "the id of the Condition", - "name": "id", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "the end ip of the portable IP range", + "name": "endip", + "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "Returns user data associated with the VM", + "isasync": false, + "name": "getVirtualMachineUserData", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "Base 64 encoded VM user data", + "name": "userdata", + "type": "string" }, + {}, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} - ] + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.4" }, { - "description": "Updates a network serviceProvider of a physical network", - "isasync": true, - "name": "updateNetworkServiceProvider", + "description": "Updates network permissions.", + "isasync": false, + "name": "createNetworkPermissions", "params": [ { - "description": "Enabled/Disabled/Shutdown the physical network service provider", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "state", + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "list" }, { - "description": "network service provider id", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "accounts", + "required": false, + "type": "list" + }, + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "the list of services to be enabled for this physical network service provider", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "servicelist", + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "list" } ], - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ - { - "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": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "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" }, { @@ -31238,38 +32595,31 @@ "type": "integer" } ], - "since": "3.0.0" + "since": "4.17.0" }, { - "description": "Lists Management Server metrics", + "description": "Lists all configurations.", "isasync": false, - "name": "listManagementServersMetrics", + "name": "listConfigurations", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the id of the management server", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "include system level stats", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the management server", + "description": "lists configuration by name", "length": 255, "name": "name", "required": false, @@ -31278,376 +32628,374 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "lists configurations by category", "length": 255, - "name": "pagesize", + "name": "category", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" - }, - {}, - { - "description": "The number of blocked threads", - "name": "threadsblockedcount", - "type": "integer" - }, - { - "description": "the name of the management server", - "name": "name", "type": "string" }, { - "description": "Total system memory", - "name": "systemmemorytotal", + "description": "lists configuration by parent name (primarily used for UI)", + "length": 255, + "name": "parent", + "required": false, + "since": "4.18.0", "type": "string" }, - {}, { - "description": "The number of threads", - "name": "threadstotalcount", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", - "type": "long" + "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 number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" + "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": false, + "type": "uuid" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "lists configuration by group name (primarily used for UI)", + "length": 255, + "name": "group", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" - }, - { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" - }, - { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" - }, - { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" + "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 number of daemon threads", - "name": "threadsdaemoncount", - "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" }, { - "description": "the ID of the management server", - "name": "id", + "description": "lists configuration by subgroup name (primarily used for UI)", + "length": 255, + "name": "subgroup", + "required": false, + "since": "4.18.0", "type": "string" - }, + } + ], + "related": "updateConfiguration", + "response": [ { - "description": "Amount of memory used", - "name": "systemmemoryused", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" - }, - { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" + "description": "the type of the configuration value", + "name": "type", + "type": "string" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "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 value of the configuration", + "name": "id", + "type": "long" }, { - "description": "Free system memory", - "name": "systemmemoryfree", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the group of the configuration", + "name": "group", "type": "string" }, + {}, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the component of the configuration", + "name": "component", "type": "string" }, + {}, { - "description": "the version of the management server", - "name": "version", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" - }, - { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" - }, - { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", - "type": "integer" - }, - { - "description": "the current cpu load", - "name": "cpuload", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, - { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", + "description": "Disables static rule for given IP address", "isasync": true, - "name": "removeFromLoadBalancerRule", + "name": "disableStaticNat", "params": [ { - "description": "The ID of the load balancer rule", + "description": "the public IP address ID for which static NAT feature is being disabled", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" - }, - { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", - "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" - }, - { - "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "list" } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {}, { "description": "the 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 vm groups", - "isasync": false, - "name": "listInstanceGroups", + "description": "Assigns secondary IP to NIC", + "isasync": true, + "name": "addIpToNic", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Secondary IP Address", "length": 255, - "name": "account", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "pagesize", - "required": false, + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the secondary private IP addr", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the ID of the nic", + "name": "nicid", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the network", + "name": "networkid", + "type": "string" + }, + { + "description": "Secondary IP address", + "name": "ipaddress", + "type": "string" + } + ] + }, + { + "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", + "isasync": true, + "name": "scaleKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, "type": "uuid" }, { - "description": "list instance groups by name", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "name", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "autoscalingenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "keyword", + "name": "nodeids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "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": "Minimum number of worker nodes in the cluster", "length": 255, - "name": "listall", + "name": "minsize", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "list instance groups by ID", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "page", + "name": "maxsize", "required": false, - "type": "integer" + "type": "long" } ], - "related": "createInstanceGroup,updateInstanceGroup", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "response": [ - {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the memory the Kubernetes cluster", + "name": "memory", "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 project ID of the instance group", - "name": "projectid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", - "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 date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -31655,564 +33003,523 @@ "type": "integer" }, { - "description": "the ID of the instance group", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the Kubernetes cluster", "name": "id", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, - {}, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" - } - ] - }, - { - "description": "migrates data objects from one secondary storage to destination image store(s)", - "isasync": true, - "name": "migrateSecondaryStorageData", - "params": [ + }, { - "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 size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "id of the image store from where the data is to be migrated", - "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "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" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, + {}, { - "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 project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + {}, { - "description": "the gateway id we are creating static route for", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", - "required": true, - "type": "uuid" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "static route cidr", - "length": 255, - "name": "cidr", - "required": true, + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" - } - ], - "related": "listStaticRoutes", - "response": [ + }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the list of resource tags associated with static route", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the ID of static route", - "name": "id", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the state of the static route", - "name": "state", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the project name of the static route", - "name": "project", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, - {}, { - "description": "static route CIDR", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" } ] }, { - "description": "Destroys a Volume.", + "description": "Stops a NetScalervm.", "isasync": true, - "name": "destroyVolume", + "name": "stopNetScalerVpx", "params": [ { - "description": "The ID of the volume", + "description": "the ID of the NetScaler vm", "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", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" }, { - "description": "If true is passed, the volume is expunged immediately. False by default.", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, - "name": "expunge", + "name": "forced", "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", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, - {}, { - "description": "pod name of the volume", - "name": "podname", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "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 version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, + {}, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "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 project name of the vpn", - "name": "project", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "name of the service offering for root disk", + "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the router", + "name": "name", "type": "string" }, - {}, - { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "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": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + } + ], + "type": "set" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -32221,236 +33528,135 @@ "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the service offering of the virtual machine", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", + "description": "the template name for the router", "name": "templatename", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "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", - "isasync": true, - "name": "addTrafficType", - "params": [ - { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "length": 255, - "name": "kvmnetworklabel", - "required": false, - "type": "string" - }, - { - "description": "the trafficType to be added to the physical network", - "length": 255, - "name": "traffictype", - "required": true, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "length": 255, - "name": "xennetworklabel", - "required": false, - "type": "string" - }, - { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "length": 255, - "name": "ovm3networklabel", - "required": false, - "type": "string" - }, - { - "description": "The VLAN id to be used for Management traffic by VMware host", - "length": 255, - "name": "vlan", - "required": false, + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "length": 255, - "name": "vmwarenetworklabel", - "required": false, - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", - "length": 255, - "name": "isolationmethod", - "required": false, + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", - "length": 255, - "name": "hypervnetworklabel", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, - {}, - {}, { - "description": "id of the network provider", - "name": "id", + "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 netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the version of template", + "name": "version", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ], - "since": "3.0.0" + ] }, { - "description": "Deletes a Private gateway", - "isasync": true, - "name": "deletePrivateGateway", + "description": "Delete a Ucs manager", + "isasync": false, + "name": "deleteUcsManager", "params": [ { - "description": "the ID of the private gateway", + "description": "ucs manager id", "length": 255, - "name": "id", - "related": "createPrivateGateway,createPrivateGateway", + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", "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", @@ -32462,68 +33668,57 @@ "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": "List all virtual machine instances that are assigned to a load balancer rule.", + "description": "Deletes a host.", "isasync": false, - "name": "listLoadBalancerRuleInstances", + "name": "deleteHost", "params": [ { - "description": "List by keyword", + "description": "the host ID", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "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": "applied", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, - "name": "lbvmips", + "name": "forcedestroylocalstorage", "required": false, "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "listLoadBalancerRuleInstances", "response": [ { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -32531,29 +33726,24 @@ "name": "jobid", "type": "string" }, - { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, { - "description": "Removes a condition for VM auto scaling", - "isasync": true, - "name": "deleteCondition", + "description": "Deletes a vm group", + "isasync": false, + "name": "deleteInstanceGroup", "params": [ { - "description": "the ID of the condition.", + "description": "the ID of the instance group", "length": 255, "name": "id", - "related": "createCondition", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": true, "type": "uuid" } @@ -32564,408 +33754,347 @@ "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {}, + {} ] }, { - "description": "Updates a domain with a new name", + "description": "deletes the resource icon from the specified resource(s)", "isasync": false, - "name": "updateDomain", + "name": "deleteResourceIcon", "params": [ { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - }, - { - "description": "updates domain with this name", + "description": "type of the resource", "length": 255, - "name": "name", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "ID of domain to update", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "resourceids", "required": true, - "type": "uuid" + "type": "list" } ], - "related": "createDomain,listDomainChildren,listDomains,listDomains", "response": [ { - "description": "the name of the domain", - "name": "name", - "type": "string" - }, - { - "description": "the path of the domain", - "name": "path", + "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 total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.16.0.0" + }, + { + "description": "Lists capabilities", + "isasync": false, + "name": "listCapabilities", + "params": [], + "related": "", + "response": [ { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", + "type": "boolean" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", "type": "long" }, { - "description": "the state of the domain", - "name": "state", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", + "type": "integer" }, + {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", "type": "long" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", + "type": "boolean" }, + {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", + "type": "boolean" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "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": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "version of the cloud stack", + "name": "cloudstackversion", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", "type": "boolean" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" }, - {}, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", + "type": "boolean" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", + "type": "integer" }, { - "description": "the ID of the domain", - "name": "id", + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Release dedication of zone", + "isasync": true, + "name": "releaseDedicatedZone", + "params": [ { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" - }, + "description": "the ID of the Zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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": "Updates a physical network", + "description": "Updates traffic type of a physical network", "isasync": true, - "name": "updatePhysicalNetwork", + "name": "updateTrafficType", "params": [ { - "description": "Tag the physical network", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "tags", + "name": "kvmnetworklabel", "required": false, - "type": "list" + "type": "string" }, { - "description": "physical network id", + "description": "traffic type id", "length": 255, "name": "id", - "related": "createPhysicalNetwork,updatePhysicalNetwork", + "related": "addTrafficType,updateTrafficType", "required": true, "type": "uuid" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "networkspeed", + "name": "xennetworklabel", "required": false, "type": "string" }, { - "description": "Enabled/Disabled", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "state", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "the VLAN for the physical network", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "vlan", + "name": "hypervnetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "length": 255, + "name": "vmwarenetworklabel", "required": false, "type": "string" } ], - "related": "createPhysicalNetwork", + "related": "addTrafficType", "response": [ { - "description": "state of the physical network", - "name": "state", - "type": "string" - }, - { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, + {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "id of the network provider", + "name": "id", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "comma separated tag", - "name": "tags", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "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": "zone id of the physical network", - "name": "zoneid", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { @@ -32974,248 +34103,207 @@ "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" - }, - { - "description": "the uuid of the physical network", - "name": "id", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" } ], "since": "3.0.0" }, { - "description": "Disables an AutoScale Vm Group", - "isasync": true, - "name": "disableAutoScaleVmGroup", + "description": "List Conditions for VM auto scaling", + "isasync": false, + "name": "listConditions", "params": [ { - "description": "the ID of the autoscale group", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, "type": "uuid" - } - ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "response": [ - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the ID of the policy", + "length": 255, + "name": "policyid", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "type": "uuid" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "Counter-id of the condition.", + "length": 255, + "name": "counterid", + "related": "createCounter,listCounters", + "required": false, + "type": "uuid" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the project id of the vm group", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, "name": "projectid", - "type": "string" + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "ID of the Condition.", + "length": 255, + "name": "id", + "related": "createCondition,listConditions", + "required": false, + "type": "uuid" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - {}, + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + } + ], + "related": "createCondition", + "response": [ { - "description": "the public port", - "name": "publicport", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, + {}, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "the account owning the vm group", + "description": "the owner of the Condition.", "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address id", - "name": "publicipid", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the private port", - "name": "privateport", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "description": "the project name of the vm group", + "description": "the project name of the Condition", "name": "project", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" - }, - { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "type": "string" }, { - "description": "the domain name of the vm group", + "description": "the domain name of the owner.", "name": "domain", "type": "string" }, + {}, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Creates a snapshot policy for the account.", - "isasync": false, - "name": "createSnapshotPolicy", + "description": "Updates a network serviceProvider of a physical network", + "isasync": true, + "name": "updateNetworkServiceProvider", "params": [ { - "description": "Map of tags (key/value pairs)", + "description": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, - "name": "tags", + "name": "state", "required": false, - "type": "map" - }, - { - "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": "maximum number of snapshots to retain", - "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" - }, - { - "description": "an optional field, whether to the display the policy to the end user or not", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "fordisplay", + "name": "servicelist", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { - "description": "the ID of the disk volume", + "description": "network service provider id", "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", + "name": "id", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": true, "type": "uuid" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "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, - "type": "string" } ], - "related": "updateSnapshotPolicy", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - {}, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -33227,199 +34315,72 @@ "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "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": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - } - ] - }, - { - "description": "create Tungsten-Fabric management network", - "isasync": false, - "name": "createTungstenFabricManagementNetwork", - "params": [ - { - "description": "the ID of pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "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" - }, {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Disables HA for a zone", - "isasync": true, - "name": "disableHAForZone", - "params": [ - { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the provider name", + "name": "name", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "uuid of the network provider", + "name": "id", "type": "string" - }, - {} + } ], - "since": "4.11" + "since": "3.0.0" }, { - "description": "list Tungsten-Fabric firewall rule", + "description": "Lists Management Server metrics", "isasync": false, - "name": "listTungstenFabricFirewallRule", + "name": "listManagementServersMetrics", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "include system level stats", "length": 255, - "name": "firewallpolicyuuid", + "name": "system", + "related": "listManagementServersMetrics", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -33429,17 +34390,16 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "the name of the management server", "length": 255, - "name": "firewallruleuuid", + "name": "name", "required": false, "type": "string" } @@ -33447,433 +34407,421 @@ "related": "", "response": [ { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", - "type": "string" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "the log files and their usage on disk", + "name": "loginfo", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, - {}, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "the IP Address for this Management Server", + "name": "serviceip", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", - "type": "string" + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" }, - {}, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" + }, + { + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The number of runnable threads", + "name": "threadsrunnablecount", "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "the current cpu load", + "name": "cpuload", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", - "type": "string" - } - ] - }, - { - "description": "List system virtual machines.", - "isasync": false, - "name": "listSystemVms", - "params": [ + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" + }, { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "3.0.1", - "type": "uuid" + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, { - "description": "the Pod ID of the system VM", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "the Zone ID of the system VM", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Free system memory", + "name": "systemmemoryfree", + "type": "string" }, { - "description": "the ID of the system VM", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "type": "uuid" + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "The number of terminated threads", + "name": "threadsteminatedcount", "type": "integer" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "The number of threads", + "name": "threadstotalcount", "type": "integer" }, { - "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 state of the management server", + "name": "state", + "type": "state" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "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": "the state of the system VM", - "length": 255, - "name": "state", - "required": false, - "type": "string" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "description": "the name of the system VM", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, { - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", + "isasync": true, + "name": "removeFromLoadBalancerRule", + "params": [ { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "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 hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "list" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" - }, + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the network domain for the system VM", - "name": "networkdomain", + "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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Lists vm groups", + "isasync": false, + "name": "listInstanceGroups", + "params": [ { - "description": "the system VM type", - "name": "systemvmtype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "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 first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the public IP address for the system VM", - "name": "publicip", - "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 private netmask for the system VM", - "name": "privatenetmask", - "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 ID of the system VM", - "name": "id", + "description": "list instance groups by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "list instance groups by ID", + "length": 255, + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": false, + "type": "uuid" + } + ], + "related": "createInstanceGroup,updateInstanceGroup", + "response": [ { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "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", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, + {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Adds an API permission to a role", - "isasync": false, - "name": "createRolePermission", + "description": "migrates data objects from one secondary storage to destination image store(s)", + "isasync": true, + "name": "migrateSecondaryStorageData", "params": [ { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "The API name or wildcard rule such as list*", + "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", "length": 255, - "name": "rule", + "name": "destpools", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, - "type": "string" + "type": "list" }, { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "id of the image store from where the data is to be migrated", "length": 255, - "name": "permission", + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "ID of the role", + "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": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "name": "migrationtype", + "required": false, + "type": "string" } ], - "related": "listRolePermissions", + "related": "", "response": [ - {}, - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" - }, - {}, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -33884,190 +34832,117 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the ID of the role permission", - "name": "id", + "description": "Response message from migration of secondary storage data objects", + "name": "message", "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, - { - "description": "the description of the role permission", - "name": "description", - "type": "string" - } + {} ], - "since": "4.9.0" + "since": "4.15.0" }, { - "description": "Creates a project", + "description": "Creates a static route", "isasync": true, - "name": "createProject", + "name": "createStaticRoute", "params": [ { - "description": "account who will be Admin for the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The display text of the project, defaults to the 'name´.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "since": "4.15.0", - "type": "uuid" - }, - { - "description": "domain ID of the account owning a project", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "name of the project", + "description": "static route cidr", "length": 255, - "name": "name", + "name": "cidr", "required": true, "type": "string" }, { - "description": "ID of the account owning a project", + "description": "the gateway id we are creating static route for", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": true, "type": "uuid" } ], - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "listStaticRoutes", "response": [ { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the domain id the project belongs to", + "description": "the ID of the domain associated with the static route", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", + "description": "the state of the static route", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the UUID of the latest async job acting on 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 memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the list of resource tags associated with vm", + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -34076,8 +34951,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -34086,13 +34961,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -34101,284 +34976,209 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "list" }, + {} + ] + }, + { + "description": "Destroys a Volume.", + "isasync": true, + "name": "destroyVolume", + "params": [ { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "If true is passed, the volume is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.6.0", + "type": "boolean" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + } + ], + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, {}, { - "description": "the name of the project", - "name": "name", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, - {}, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the status of the volume", + "name": "status", "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": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" }, - { - "description": "the ID of the certificate", - "length": 255, - "name": "certid", - "related": "uploadSslCert", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" - } - ] - }, - { - "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 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": "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the 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": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -34387,9 +35187,9 @@ "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "the project name of the vpn", @@ -34397,62 +35197,57 @@ "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", + "description": "the date the volume was attached to a VM instance", + "name": "attached", "type": "date" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -34461,122 +35256,106 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the ID of 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 storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "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", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "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 write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { @@ -34585,201 +35364,218 @@ "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, + {} + ], + "since": "4.14.0" + }, + { + "description": "Adds traffic type to a physical network", + "isasync": true, + "name": "addTrafficType", + "params": [ { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "length": 255, + "name": "vmwarenetworklabel", + "required": false, + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "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": "name of the disk volume", - "name": "name", + "description": "The VLAN id to be used for Management traffic by VMware host", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "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": "pod id of the volume", - "name": "podid", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "length": 255, + "name": "xennetworklabel", + "required": false, "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "length": 255, + "name": "isolationmethod", + "required": false, "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the trafficType to be added to the physical network", + "length": 255, + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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" - }, + } + ], + "related": "", + "response": [ { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "id of the network provider", + "name": "id", + "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, {} - ] + ], + "since": "3.0.0" }, { - "description": "Replaces ACL associated with a network or private gateway", + "description": "Deletes a Private gateway", "isasync": true, - "name": "replaceNetworkACLList", + "name": "deletePrivateGateway", "params": [ { "description": "the ID of the private gateway", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the network ACL", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "id", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": true, "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" } ], "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": "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", @@ -34788,253 +35584,303 @@ ] }, { - "description": "list Tungsten-Fabric address group", + "description": "Lists the secondary storage selectors and their rules.", "isasync": false, - "name": "listTungstenFabricAddressGroup", + "name": "listSecondaryStorageSelectors", "params": [ { - "description": "the ID of zone", + "description": "Show removed heuristics.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "showremoved", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "List by keyword", "length": 255, - "name": "addressgroupuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "The zone ID to be used in the search filter.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" } ], - "related": "createTungstenFabricAddressGroup", + "related": "createSecondaryStorageSelector,updateSecondaryStorageSelector,removeSecondaryStorageSelector", "response": [ { - "description": "Tungsten-Fabric address group name", + "description": "Name of the heuristic.", "name": "name", "type": "string" }, + {}, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Description of the heuristic.", + "name": "description", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, - {}, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, - {} - ] + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + } + ], + "since": "4.19.0" }, { - "description": "Marks a default zone for this account", - "isasync": true, - "name": "markDefaultZoneForAccount", + "description": "List all virtual machine instances that are assigned to a load balancer rule.", + "isasync": false, + "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "Name of the account that is to be marked.", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": true, - "type": "string" + "name": "applied", + "required": false, + "type": "boolean" }, { - "description": "Marks the account that belongs to the specified domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "The Zone ID with which the account is to be marked.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "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 total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "listLoadBalancerRuleInstances", + "response": [ + {}, + { + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" }, + {}, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Removes a condition for VM auto scaling", + "isasync": true, + "name": "deleteCondition", + "params": [ { - "description": "the id of the account", + "description": "the ID of the condition.", + "length": 255, "name": "id", - "type": "string" - }, + "related": "createCondition", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "any text associated with the success or failure", + "name": "displaytext", "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" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Updates a domain with a new name", + "isasync": false, + "name": "updateDomain", + "params": [ { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "updates domain with this name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, + "description": "ID of domain to update", + "length": 255, + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + } + ], + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "response": [ { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of public ip addresses this 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 total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { @@ -35043,336 +35889,180 @@ "type": "resourceiconresponse" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", + "description": "the total number of cpu cores owned by domain", "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, - {}, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the state of the domain", + "name": "state", + "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 domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) owned by account", + "description": "the total secondary storage space (in GiB) owned by domain", "name": "secondarystoragetotal", "type": "float" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "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 has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "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 account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - } - ], - "type": "list" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", "type": "string" }, {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", + "description": "the total number of virtual machines deployed by this domain", "name": "vmtotal", "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", + "description": "the total number of virtual machines available for this domain to acquire", "name": "vmavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the 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 owned by account", - "name": "networktotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" - } - ], - "since": "4.0" - }, - { - "description": "Enables out-of-band management for a zone", - "isasync": true, - "name": "enableOutOfBandManagementForZone", - "params": [ - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", - "response": [ - { - "description": "the operation result", - "name": "status", - "type": "boolean" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { @@ -35381,580 +36071,397 @@ "type": "integer" }, { - "description": "the operation result description", - "name": "description", - "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": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" - }, - {} - ], - "since": "4.9.0" + } + ] }, { - "description": "Lists LDAP Users according to the specifications from the user request.", - "isasync": false, - "name": "listLdapUsers", + "description": "Updates a physical network", + "isasync": true, + "name": "updatePhysicalNetwork", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "linked domain", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "networkspeed", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Enabled/Disabled", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "description": "Tag the physical network", "length": 255, - "name": "listtype", + "name": "tags", "required": false, - "type": "string" + "type": "list" }, { - "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 VLAN for the physical network", "length": 255, - "name": "userfilter", + "name": "vlan", "required": false, - "since": "4.13", "type": "string" }, { - "description": "List by keyword", + "description": "physical network id", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "id", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "createPhysicalNetwork", "response": [ { - "description": "The user's domain", - "name": "domain", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "The user's email", - "name": "email", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "The user's principle", - "name": "principal", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, - {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "name of the physical network", + "name": "name", "type": "string" }, + {}, { - "description": "The user's username", - "name": "username", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Revokes certificate using configured CA plugin", - "isasync": true, - "name": "revokeCertificate", - "params": [ - { - "description": "The certificate CN", - "length": 255, - "name": "cn", - "required": false, + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "The certificate serial number, as a hex value", - "length": 255, - "name": "serial", - "required": true, + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - } - ], - "response": [ - { - "description": "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": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "state of the physical network", + "name": "state", + "type": "string" + }, + {} ], - "since": "4.11.0" + "since": "3.0.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", + "description": "Disables an AutoScale Vm Group", + "isasync": true, + "name": "disableAutoScaleVmGroup", "params": [ { - "description": "The ID of the system vm", + "description": "the ID of the autoscale group", "length": 255, "name": "id", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - }, - { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the service offering ID to apply to the system vm", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "required": true, "type": "uuid" } ], - "related": "migrateSystemVm,startSystemVm", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, - {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "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 gateway for the system VM", - "name": "gateway", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, + {}, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, - {}, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the public port", + "name": "publicport", "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 date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "is group for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, + {}, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" } ] }, { - "description": "Create VM Schedule", + "description": "Creates a snapshot policy for the account.", "isasync": false, - "name": "createVMSchedule", + "name": "createSnapshotPolicy", "params": [ { - "description": "Action to take on the VM (start/stop/restart/force_stop/force_reboot).", + "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": "action", + "name": "schedule", "required": true, "type": "string" }, { - "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "name": "intervaltype", + "required": true, + "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "an optional field, whether to the display the policy to the end user or not", "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" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "the ID of the disk volume", "length": 255, - "name": "schedule", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", "length": 255, - "name": "timezone", - "required": true, - "type": "string" + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" }, { - "description": "Description of the schedule", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "description", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "name": "timezone", + "required": true, + "type": "string" }, { - "description": "Enable VM schedule. Defaults to true", + "description": "maximum number of snapshots to retain", "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "name": "maxsnaps", + "required": true, + "type": "integer" } ], - "related": "updateVMSchedule", + "related": "updateSnapshotPolicy", "response": [ { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, - { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" + "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": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, + {}, { - "description": "VM schedule is enabled", - "name": "enabled", + "description": "is this policy for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "Action", - "name": "action", - "type": "action" - }, - { - "description": "Description of VM schedule", - "name": "description", - "type": "string" - }, - { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" - }, - { - "description": "Cron formatted VM schedule", + "description": "time the snapshot is scheduled to be taken.", "name": "schedule", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.19.0" - }, - { - "description": "Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console", - "isasync": false, - "name": "cloudianSsoLogin", - "params": [], - "related": "", - "response": [ - { - "description": "the sso redirect url", - "name": "url", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { @@ -35962,592 +36469,423 @@ "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 resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list the rule belonging to this public IP address", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, - { - "description": "Lists all rules applied to the specified VM.", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", - "response": [ - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - {}, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "type": "set" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, + {} + ] + }, + { + "description": "create Tungsten-Fabric management network", + "isasync": false, + "name": "createTungstenFabricManagementNetwork", + "params": [ { - "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 pod", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "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 public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Disables HA for a zone", + "isasync": true, + "name": "disableHAForZone", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.11" }, { - "description": "Creates an instant snapshot of a volume.", - "isasync": true, - "name": "createSnapshot", + "description": "list Tungsten-Fabric firewall rule", + "isasync": false, + "name": "listTungstenFabricFirewallRule", "params": [ { - "description": "the name of the snapshot", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "name", + "name": "firewallruleuuid", "required": false, "type": "string" }, { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy", + "name": "firewallpolicyuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "description": "", "length": 255, - "name": "locationtype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Map of tags (key/value pairs)", + "description": "the ID of zone", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "map" - }, - { - "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": "asynchronous backup if true", - "length": 255, - "name": "asyncbackup", - "required": false, - "type": "boolean" - }, - { - "description": "quiesce vm if true", + "description": "", "length": 255, - "name": "quiescevm", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", + "related": "", "response": [ { - "description": "the project name of the snapshot", - "name": "project", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, + {}, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, - {}, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, { - "description": "name of the snapshot", - "name": "name", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, - {}, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "Adds an API permission to a role", + "isasync": false, + "name": "createRolePermission", + "params": [ { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - } - ] - }, - { - "description": "Deletes a vmsnapshot.", - "isasync": true, - "name": "deleteVMSnapshot", - "params": [ - { - "description": "The ID of the VM snapshot", + "description": "ID of the role", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": true, "type": "uuid" + }, + { + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" } ], + "related": "listRolePermissions", "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" + }, + { + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" + }, + { + "description": "the ID of the role permission", + "name": "id", + "type": "string" + }, { "description": "the 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 name of the role to which the role permission belongs", + "name": "rolename", + "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the api name or wildcard rule", + "name": "rule", + "type": "string" + }, + { + "description": "the description of the role permission", + "name": "description", "type": "string" }, {} ], - "since": "4.2.0" + "since": "4.9.0" }, { - "description": "Lists storage pool metrics", + "description": "List system virtual machines.", "isasync": false, - "name": "listStoragePoolsMetrics", + "name": "listSystemVms", "params": [ { - "description": "List by keyword", + "description": "the state of the system VM", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "the status of the storage pool", + "description": "List by keyword", "length": 255, - "name": "status", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "scope", + "name": "storageid", "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "since": "3.0.1", + "type": "uuid" }, { - "description": "the ID of the storage pool", + "description": "the Zone ID of the system VM", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "the ID of the system VM", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "uuid" }, @@ -36559,22 +36897,7 @@ "type": "integer" }, { - "description": "the storage pool path", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, - { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID for the storage pool", + "description": "the Pod ID of the system VM", "length": 255, "name": "podid", "related": "updatePod,createManagementNetworkIpRange", @@ -36582,16 +36905,16 @@ "type": "uuid" }, { - "description": "the name of the storage pool", + "description": "the name of the system VM", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "ipaddress", + "name": "systemvmtype", "required": false, "type": "string" }, @@ -36601,797 +36924,750 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the host ID of the system VM", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" } ], - "related": "", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the ID of the storage pool", - "name": "id", + "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": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the storage pool type", - "name": "type", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, - {}, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "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": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, + {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the template ID for the system VM", + "name": "templateid", "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": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" - } - ], - "since": "4.9.3" - }, - { - "description": "Unmanage a guest virtual machine.", - "isasync": true, - "name": "unmanageVirtualMachine", - "params": [ + }, { - "description": "The ID of the virtual machine to unmanage", - "length": 255, + "description": "the ID of the system VM", "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": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "details of the unmanage VM operation", - "name": "details", - "type": "string" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, - {} - ], - "since": "4.15.0" + {}, + { + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + } + ] }, { - "description": "Starts a router.", + "description": "Creates a project", "isasync": true, - "name": "rebootRouter", + "name": "createProject", "params": [ { - "description": "the ID of the router", + "description": "domain ID of the account owning a project", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "Force reboot the router (Router is force Stopped and then Started)", + "description": "account who will be Admin for the project", "length": 255, - "name": "forced", + "name": "account", "required": false, - "since": "4.16.0", - "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the link local IP address for the router", - "name": "linklocalip", "type": "string" }, { - "description": "the name of the router", + "description": "name of the project", + "length": 255, "name": "name", + "required": true, "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "The display text of the project, defaults to the 'name´.", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "since": "4.15.0", + "type": "uuid" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "ID of the account owning a project", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "response": [ + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "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 ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the project name of the address", - "name": "project", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, + {}, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "role of the domain router", - "name": "role", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the name of the project", + "name": "name", "type": "string" }, - {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated with vm", + "name": "tags", "response": [ { - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the account associated with the tag", + "name": "account", "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "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 date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, + {}, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "Assigns a certificate to a load balancer rule", + "isasync": true, + "name": "assignCertToLoadBalancer", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the ID of the certificate", + "length": 255, + "name": "certid", + "related": "uploadSslCert", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] }, { - "description": "list the vm nics IP to NIC", + "description": "Adds a Cisco Vnmc Controller", "isasync": false, - "name": "listNics", + "name": "addCiscoVnmcResource", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", - "required": false, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "Hostname or ip address of the Cisco VNMC Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "page", - "required": false, + "name": "password", + "required": true, + "type": "string" + } + ], + "related": "listCiscoVnmcResources", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, + {}, + {}, { - "description": "list nic of the specific vm's network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the 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": "the ID of the vm", + "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": true, + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, "type": "uuid" }, { - "description": "", + "description": "the device ID on the virtual machine where volume is detached from", "length": 255, - "name": "pagesize", + "name": "deviceid", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the ID of the nic to to list IPs", + "description": "the ID of the disk volume", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" } ], - "related": "", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { @@ -37400,95 +37676,93 @@ "type": "integer" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, - {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 nic", - "name": "id", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -37497,224 +37771,186 @@ "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" - } - ] - }, - { - "description": "Deletes a backup offering", - "isasync": false, - "name": "deleteBackupOffering", - "params": [ + }, { - "description": "ID of the backup offering", - "length": 255, - "name": "id", - "related": "listBackupProviderOfferings,importBackupOffering,updateBackupOffering", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, - {} - ], - "since": "4.14.0" - }, - { - "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, + "description": "display name of the virtual machine", + "name": "vmdisplayname", "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": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" - } - ], - "related": "", - "response": [ - {}, - {}, + }, { - "description": "the owner of the keypair", - "name": "account", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "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": "Private key", - "name": "privatekey", + "description": "the path of the volume", + "name": "path", "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 project id of the keypair owner", - "name": "projectid", + "description": "the status of the volume", + "name": "status", "type": "string" }, + {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" - } - ] - }, - { - "description": "Creates an instant snapshot of a volume from existing vm snapshot.", - "isasync": true, - "name": "createSnapshotFromVMSnapshot", - "params": [ + }, { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - } - ], - "related": "archiveSnapshot,revertSnapshot", - "response": [ - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { "description": "the list of resource tags associated", @@ -37726,13 +37962,18 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -37746,13 +37987,8 @@ "type": "string" }, { - "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" }, { @@ -37761,8 +37997,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -37774,133 +38010,100 @@ "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "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 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": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the project name of the vpn", + "name": "project", "type": "string" - }, + } + ] + }, + { + "description": "Replaces ACL associated with a network or private gateway", + "isasync": true, + "name": "replaceNetworkACLList", + "params": [ { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "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 project name of the snapshot", - "name": "project", - "type": "string" + "description": "the ID of the private gateway", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "ID of the snapshot", - "name": "id", - "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 project id of the snapshot", - "name": "projectid", - "type": "string" - }, - {} - ], - "since": "4.10.0" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] }, { - "description": "list Tungsten-Fabric service group", + "description": "list Tungsten-Fabric address group", "isasync": false, - "name": "listTungstenFabricServiceGroup", + "name": "listTungstenFabricAddressGroup", "params": [ { - "description": "the uuid of Tungsten-Fabric service group", + "description": "List by keyword", "length": 255, - "name": "servicegroupuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "pagesize", + "name": "addressgroupuuid", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of zone", @@ -37913,19 +38116,19 @@ { "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": "createTungstenFabricServiceGroup", + "related": "createTungstenFabricAddressGroup", "response": [ { "description": "the UUID of the latest async job acting on this object", @@ -37933,147 +38136,114 @@ "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "Tungsten-Fabric service group end port", - "name": "endport", + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", "type": "int" }, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" } ] }, { - "description": "Authorizes a particular egress rule for this security group", + "description": "Marks a default zone for this account", "isasync": true, - "name": "authorizeSecurityGroupEgress", + "name": "markDefaultZoneForAccount", "params": [ { - "description": "type of the icmp message being sent", + "description": "The Zone ID with which the account is to be marked.", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "end port for this egress rule", + "description": "Marks the account that belongs to the specified domain.", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "Name of the account that is to be marked.", "length": 255, "name": "account", - "required": false, + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": true, "type": "string" - }, + } + ], + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "response": [ { - "description": "start port for this egress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, + "description": "the list of acl groups that account belongs to", + "name": "groups", "type": "list" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "uuid" - }, - { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "TCP is default. UDP is the other supported protocol", - "length": 255, - "name": "protocol", - "required": false, + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "user to security group mapping", - "length": 255, - "name": "usersecuritygrouplist", - "required": false, - "type": "map" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", - "length": 255, - "name": "securitygroupname", - "required": false, + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "an optional project of the security group", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "authorizeSecurityGroupIngress", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { @@ -38082,866 +38252,1016 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of 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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "customer associated with the tag", - "name": "customer", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "account owning the security group rule", - "name": "account", + "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 type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Lists storage pools.", - "isasync": false, - "name": "listStoragePools", - "params": [ + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the ID of the storage pool", - "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the storage pool path", - "length": 255, - "name": "path", - "required": false, + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the storage pool", - "length": 255, - "name": "name", - "required": false, + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "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 total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the status of the storage pool", - "length": 255, - "name": "status", - "required": false, - "type": "string" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "response": [ - {}, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, - {}, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "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", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the storage pool path", - "name": "path", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, + {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + } + ], + "since": "4.0" + }, + { + "description": "Enables out-of-band management for a zone", + "isasync": true, + "name": "enableOutOfBandManagementForZone", + "params": [ + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", + "response": [ + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" } - ] + ], + "since": "4.9.0" }, { - "description": "Updates a hypervisor capabilities.", + "description": "Lists LDAP Users according to the specifications from the user request.", "isasync": false, - "name": "updateHypervisorCapabilities", + "name": "listLdapUsers", "params": [ { - "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 security group for this hypervisor.", + "description": "List by keyword", "length": 255, - "name": "securitygroupenabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "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": "maxdatavolumeslimit", + "name": "userfilter", "required": false, - "since": "4.16.0", - "type": "integer" + "since": "4.13", + "type": "string" }, { - "description": "the max number of Guest VMs per host for this hypervisor.", + "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": "maxguestslimit", + "name": "listtype", "required": false, - "type": "long" + "type": "string" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "linked domain", "length": 255, - "name": "vmsnapshotenabled", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "uuid" }, { - "description": "set true to enable storage motion support for this hypervisor", + "description": "", "length": 255, - "name": "storagemotionenabled", + "name": "page", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "integer" }, { - "description": "ID of the hypervisor capability", + "description": "", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "listHypervisorCapabilities", + "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": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "description": "The user's domain", + "name": "domain", + "type": "string" }, + {}, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" + "description": "The user's email", + "name": "email", + "type": "string" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "The user's username", + "name": "username", "type": "string" }, - {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "The user's principle", + "name": "principal", + "type": "string" }, { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "hypervisortype" + "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 maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" - }, + "description": "The user's firstname", + "name": "firstname", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Revokes certificate using configured CA plugin", + "isasync": true, + "name": "revokeCertificate", + "params": [ { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "The certificate CN", + "length": 255, + "name": "cn", + "required": false, + "type": "string" }, + { + "description": "The certificate serial number, as a hex value", + "length": 255, + "name": "serial", + "required": true, + "type": "string" + } + ], + "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ], - "since": "3.0.0" + "since": "4.11.0" }, { - "description": "Find hosts suitable for migrating a virtual machine.", + "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": "findHostsForMigration", + "name": "changeServiceForSystemVm", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", + "description": "the service offering ID to apply to the system 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", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "", + "description": "The ID of the system vm", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "type": "map" } ], - "related": "", + "related": "migrateSystemVm,startSystemVm", "response": [ { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, + {}, { - "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 amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the date and time the host was created", + "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "long" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, - {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the host version", - "name": "version", + "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 public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "averageload", - "type": "long" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "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 link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the ID of the host", + "description": "the ID of the system VM", "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the name of the system VM", + "name": "name", "type": "string" }, {}, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "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 IP address of the host", - "name": "ipaddress", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the 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 second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the 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": "Return true if the specified account is allowed to create offerings with tags.", + "description": "Update SIOC info", "isasync": false, - "name": "isAccountAllowedToCreateOfferingsWithTags", + "name": "updateSiocInfo", "params": [ { - "description": "Account UUID", + "description": "Storage Pool ID", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, + { + "description": "Shares per GB", + "length": 255, + "name": "sharespergb", + "required": true, + "type": "integer" + }, + { + "description": "Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" + }, + { + "description": "Notify if IOPS above this value", + "length": 255, + "name": "iopsnotifythreshold", + "required": true, + "type": "integer" + }, + { + "description": "Limit IOPS per GB", + "length": 255, + "name": "limitiopspergb", + "required": true, + "type": "integer" } ], "related": "", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "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 return message from the operation ('Success' if successful)", + "name": "msg", + "type": "string" } - ] + ], + "since": "4.11.0" }, { - "description": "Dedicates a guest vlan range to an account", + "description": "Create VM Schedule", "isasync": false, - "name": "dedicateGuestVlanRange", + "name": "createVMSchedule", "params": [ { - "description": "guest vlan range to be dedicated", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "vlanrange", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "length": 255, + "name": "schedule", "required": true, "type": "string" }, { - "description": "account who will own the VLAN", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "account", + "name": "enddate", "required": false, + "type": "date" + }, + { + "description": "Action to take on the VM (start/stop/restart/force_stop/force_reboot).", + "length": 255, + "name": "action", + "required": true, "type": "string" }, { - "description": "project who will own the VLAN", + "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "physical network ID of the vlan", + "description": "Enable VM schedule. Defaults to true", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "domain ID of the account owning a VLAN", + "description": "Description of the schedule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "description", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": true, + "type": "string" } ], - "related": "listDedicatedGuestVlanRanges", + "related": "updateVMSchedule", "response": [ { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, - {}, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { @@ -38950,171 +39270,202 @@ "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", - "type": "string" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, {}, + {}, { - "description": "the project id of the guest vlan range", - "name": "projectid", - "type": "string" + "description": "Action", + "name": "action", + "type": "action" }, { - "description": "the ID of the guest VLAN range", + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "the ID of VM schedule", "name": "id", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "Description of VM schedule", + "name": "description", + "type": "string" + }, + { + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" - }, - { - "description": "the project name of the guest vlan range", - "name": "project", - "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Adds VM to specified network by creating a NIC", - "isasync": true, - "name": "addNicToVirtualMachine", + "description": "List the IP forwarding rules", + "isasync": false, + "name": "listIpForwardingRules", "params": [ { - "description": "Mac Address for the new network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "macaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "dhcpoptions", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "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" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "IP Address for the new network", + "description": "List by keyword", "length": 255, - "name": "ipaddress", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Network ID", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, "type": "uuid" - } - ], - "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "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 ID of the host for the virtual machine", - "name": "hostid", - "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 name of userdata used for the VM", - "name": "userdataname", - "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 name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", + "response": [ + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -39123,937 +39474,418 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "length": 255, + "name": "policyid", + "related": "updateSnapshotPolicy", + "required": false, + "type": "uuid" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "length": 255, + "name": "locationtype", + "required": false, "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "list" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + } + ], + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "response": [ + { + "description": "ID of the snapshot", + "name": "id", "type": "string" }, - {}, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "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 account owning the security group", - "name": "account", + "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 project id of the group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the 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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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 ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - } - ], - "type": "set" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the 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": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "display name of the os on volume", + "name": "osdisplayname", "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": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the status of the template", + "name": "status", "type": "string" }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "the 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 password (if exists) of the virtual machine", - "name": "password", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, + {}, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "name of the snapshot", + "name": "name", "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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the 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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" } ] }, { - "description": "Returns SAML2 CloudStack Service Provider MetaData", - "isasync": false, - "name": "getSPMetadata", - "params": [], - "related": "", + "description": "Deletes a vmsnapshot.", + "isasync": true, + "name": "deleteVMSnapshot", + "params": [ + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -40063,1229 +39895,1209 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "The Metadata XML", - "name": "metadata", - "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Lists all static routes", + "description": "Lists storage pool metrics", "isasync": false, - "name": "listStaticRoutes", + "name": "listStoragePoolsMetrics", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the storage pool", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the IP address for the storage pool", "length": 255, - "name": "page", + "name": "ipaddress", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "host ID of the storage pools", "length": 255, - "name": "account", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the status of the storage pool", "length": 255, - "name": "keyword", + "name": "status", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list static routes by state", + "description": "the storage pool path", "length": 255, - "name": "state", + "name": "path", "required": false, "type": "string" }, { - "description": "list static route by id", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "id", - "related": "listStaticRoutes", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "list static routes by gateway id", + "description": "", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the scope of the storage pool", "length": 255, - "name": "tags", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "map" + "type": "string" }, { - "description": "list static routes by vpc id", + "description": "the name of the storage pool", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, - {}, { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the state of the static route", - "name": "state", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "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": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" }, { - "description": "the project name of the static route", - "name": "project", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the list of resource tags associated with static route", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, - {} - ] - }, - { - "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": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the scope of the storage pool", + "name": "scope", + "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": "disk size used in GiB", + "name": "disksizeusedgb", + "type": "string" }, { - "description": "lists all public IP addresses by physical network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "list only IPs used for load balancing", - "length": 255, - "name": "forloadbalancing", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "list only source NAT IP addresses", - "length": 255, - "name": "issourcenat", - "required": false, + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "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,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.13.0", - "type": "uuid" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "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": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "list only static NAT IP addresses", - "length": 255, - "name": "isstaticnat", - "required": false, + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", "type": "boolean" }, { - "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": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "lists the specified IP address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, + {}, { - "description": "lists all public IP addresses by state", - "length": 255, - "name": "state", - "required": false, + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + } + ], + "since": "4.9.3" + }, + { + "description": "Unmanage a guest virtual machine.", + "isasync": true, + "name": "unmanageVirtualMachine", + "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the virtual machine to unmanage", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" - }, + } + ], + "related": "", + "response": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "the virtual network for the IP address", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" }, + {}, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "result of the unmanage VM operation", + "name": "success", "type": "boolean" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Starts a router.", + "isasync": true, + "name": "rebootRouter", + "params": [ { - "description": "", + "description": "Force reboot the router (Router is force Stopped and then Started)", "length": 255, - "name": "pagesize", + "name": "forced", "required": false, - "type": "integer" + "since": "4.16.0", + "type": "boolean" }, { - "description": "lists IP address by ID", + "description": "the ID of the router", "length": 255, "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, "type": "uuid" } ], - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "VPC id the ip belongs to", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "VPC the router belongs to", "name": "vpcid", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the version of template", + "name": "version", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the list of resource tags associated with ip address", - "name": "tags", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the account the public IP address is associated with", - "name": "account", - "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 domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the 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 ID of the Network where ip belongs to", - "name": "networkid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "description": "the state of the router", "name": "state", - "type": "string" + "type": "state" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the public netmask for the router", + "name": "publicnetmask", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "public IP address id", - "name": "id", + "description": "the version of the code / software in the router", + "name": "softwareversion", "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 guest IP address for the router", + "name": "guestipaddress", "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 physical network this belongs to", - "name": "physicalnetworkid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" - } - ] - }, - { - "description": "Updates an ISO file.", - "isasync": false, - "name": "updateIso", - "params": [ - { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" }, { - "description": "the ID of the 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": "true if image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, - { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the format for the image", - "length": 255, - "name": "format", - "required": false, + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" - }, - { - "description": "the 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": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - } - ], - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, - {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", + "description": "the date and time the router was created", + "name": "created", "type": "date" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the template ID", - "name": "id", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" - }, + } + ] + }, + { + "description": "list the vm nics IP to NIC", + "isasync": false, + "name": "listNics", + "params": [ { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the ID of the nic to list IPs", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "list nic of the specific vm's network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the project name of the template", - "name": "project", + "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 type of the template", - "name": "templatetype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "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", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, + {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, + {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the template name", - "name": "name", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ] }, { - "description": "Lists OpenDyalight controllers", + "description": "Create a new keypair and returns the private key", "isasync": false, - "name": "listOpenDaylightControllers", + "name": "createSSHKeyPair", "params": [ { - "description": "the ID of a OpenDaylight Controller", + "description": "Name of the keypair", "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" } ], - "related": "addOpenDaylightController,deleteOpenDaylightController", + "related": "", "response": [ { - "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 domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name assigned to the controller", + "description": "Name of the keypair", "name": "name", "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" + }, + { + "description": "the owner of the keypair", + "name": "account", "type": "string" }, {}, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the domain name of the keypair owner", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the keypair owner", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Adds a BigSwitch BCF Controller device", + "description": "Creates an instant snapshot of a volume from existing vm snapshot.", "isasync": true, - "name": "addBigSwitchBcfDevice", + "name": "createSnapshotFromVMSnapshot", "params": [ { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, - { - "description": "Username of the BigSwitch BCF Controller.", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "NAT support of the BigSwitch BCF Controller.", + "description": "The ID of the disk volume", "length": 255, - "name": "nat", + "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": "boolean" + "type": "uuid" }, { - "description": "Password of the BigSwitch BCF Controller.", + "description": "the name of the snapshot", "length": 255, - "name": "password", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "The ID of the VM snapshot", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" } ], - "related": "listBigSwitchBcfDevices", + "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, - {}, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { @@ -41294,1341 +41106,1393 @@ "type": "integer" }, { - "description": "the controller password", - "name": "password", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, - {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "NAT support", - "name": "nat", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the controller username", - "name": "username", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", - "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": "any text associated with the success or failure", - "name": "displaytext", + "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 domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" - } - ] - }, - { - "description": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", - "params": [ - { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,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": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "name of the disk volume", + "name": "volumename", + "type": "string" + }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project name where tag belongs to", + "name": "project", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "resource type", + "name": "resourcetype", "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + } + ], + "type": "set" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + {}, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + } + ], + "since": "4.10.0" + }, + { + "description": "list Tungsten-Fabric service group", + "isasync": false, + "name": "listTungstenFabricServiceGroup", + "params": [ + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "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, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "createTungstenFabricServiceGroup", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + { + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Authorizes a particular egress rule for this security group", + "isasync": true, + "name": "authorizeSecurityGroupEgress", + "params": [ + { + "description": "user to security group mapping", + "length": 255, + "name": "usersecuritygrouplist", + "required": false, + "type": "map" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "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": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "length": 255, + "name": "securitygroupname", + "required": false, + "type": "string" + }, + { + "description": "TCP is default. UDP is the other supported protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "an optional project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "length": 255, + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", + "required": false, + "type": "uuid" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "start port for this egress rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "end port for this egress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + } + ], + "related": "authorizeSecurityGroupIngress", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + {}, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + {}, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the 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 traffic type of the nic", - "name": "traffictype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "tag key name", + "name": "key", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Lists storage pools.", + "isasync": false, + "name": "listStoragePools", + "params": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the IP address for the storage pool", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "list storage pools belongig to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "host ID of the storage pools", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the storage pool", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the storage pool path", + "length": 255, + "name": "path", + "required": false, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the scope of the storage pool", + "length": 255, + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the status of the storage pool", + "length": 255, + "name": "status", + "required": false, "type": "string" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "response": [ + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the date when this virtual machine was created", + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + {}, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "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": "Lists objects at specified path on an image store.", + "isasync": false, + "name": "listImageStoreObjects", + "params": [ + { + "description": "path to list on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "id of the image store", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Template ID associated with the data store object.", "name": "templateid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + { + "description": "Size is in Bytes.", + "name": "size", + "type": "long" + }, + {}, + {}, + { + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates a hypervisor capabilities.", + "isasync": false, + "name": "updateHypervisorCapabilities", + "params": [ + { + "description": "the max number of Guest VMs per host for this hypervisor.", + "length": 255, + "name": "maxguestslimit", + "required": false, + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "length": 255, + "name": "maxdatavolumeslimit", + "required": false, + "since": "4.16.0", + "type": "integer" + }, + { + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "set true to enable security group for this hypervisor.", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + }, + { + "description": "set true to enable VM snapshots for this hypervisor", + "length": 255, + "name": "vmsnapshotenabled", + "required": false, + "since": "4.16.0", + "type": "boolean" + } + ], + "related": "listHypervisorCapabilities", + "response": [ + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" + }, + {}, + { + "description": "the ID of the hypervisor capabilities row", "name": "id", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", "type": "boolean" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if security group is supported", + "name": "securitygroupenabled", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" + }, + { + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Find hosts suitable for migrating a virtual machine.", + "isasync": false, + "name": "findHostsForMigration", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "the cpu average load on the host", + "name": "averageload", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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", "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", "type": "long" }, - {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + {}, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 name of userdata used for the VM", - "name": "userdataname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project 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": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "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" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "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 name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the Zone ID of the host", + "name": "zoneid", "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" } ] }, { - "description": "Deletes a user for an account", - "isasync": false, - "name": "deleteUser", + "description": "Enable a Cisco Nexus VSM device", + "isasync": true, + "name": "enableCiscoNexusVSM", "params": [ { - "description": "id of the user to be deleted", + "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", "required": true, "type": "uuid" } ], + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, - {} - ] - }, - { - "description": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", - "params": [ - { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", - "length": 255, - "name": "timeout", - "required": false, - "type": "long" - }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, - { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", - "length": 255, - "name": "action", - "required": true, - "type": "string" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Issues a client certificate using configured or provided CA plugin", - "isasync": true, - "name": "issueCertificate", - "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": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "Comma separated list of IP addresses, the certificate should be issued for", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "device name", + "name": "vsmdevicename", "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, + "description": "device state", + "name": "vsmdevicestate", "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": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "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" - } - ], - "related": "listCaCertificate", - "response": [ - { - "description": "The client certificate", - "name": "certificate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" } - ], - "since": "4.11.0" + ] }, { - "description": "Deletes network device.", + "description": "Return true if the specified account is allowed to create offerings with tags.", "isasync": false, - "name": "deleteNetworkDevice", + "name": "isAccountAllowedToCreateOfferingsWithTags", "params": [ { - "description": "Id of network device to delete", + "description": "Account UUID", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "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", @@ -42641,50 +42505,74 @@ "type": "integer" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ] }, { - "description": "Updates image store read-only status", + "description": "Dedicates a guest vlan range to an account", "isasync": false, - "name": "updateImageStore", + "name": "dedicateGuestVlanRange", "params": [ { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "description": "account who will own the VLAN", "length": 255, - "name": "readonly", - "required": true, - "type": "boolean" + "name": "account", + "required": false, + "type": "string" }, { - "description": "Image Store UUID", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "physical network ID of the vlan", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, "type": "uuid" + }, + { + "description": "guest vlan range to be dedicated", + "length": 255, + "name": "vlanrange", + "required": true, + "type": "string" } ], - "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "listDedicatedGuestVlanRanges", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" }, + {}, { - "description": "the name of the image store", - "name": "name", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, { @@ -42693,8 +42581,8 @@ "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, { @@ -42703,351 +42591,377 @@ "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, + {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", "type": "long" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" } - ], - "since": "4.15.0" + ] }, { - "description": "Creates a port forwarding rule", + "description": "Adds VM to specified network by creating a NIC", "isasync": true, - "name": "createPortForwardingRule", + "name": "addNicToVirtualMachine", "params": [ { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "Mac Address for the new network", "length": 255, - "name": "vmguestip", + "name": "macaddress", "required": false, "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": "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": "IP Address for the new network", "length": 255, - "name": "openfirewall", + "name": "ipaddress", "required": false, - "type": "boolean" - }, - { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", + "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": "publicendport", + "name": "dhcpoptions", "required": false, - "type": "integer" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "type": "map" }, { - "description": "the IP address id of the port forwarding rule", + "description": "Network ID", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "Virtual Machine ID", "length": 255, "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,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,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the network of the 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 public port range", - "length": 255, - "name": "publicport", - "required": true, - "type": "integer" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "privateendport", - "required": false, - "type": "integer" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the 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 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 ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the state of the rule", - "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 VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ] - }, - { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", - "params": [ - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the Name of the Zone", - "name": "zonename", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + {}, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { @@ -43056,54 +42970,74 @@ "type": "integer" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, {}, - {} - ] - }, - { - "description": "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": "Base64 string containing the user data", + "name": "userdata", + "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 project name of the vm", + "name": "project", + "type": "string" }, { - "description": "zone ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { @@ -43112,236 +43046,240 @@ "type": "resourceiconresponse" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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 template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", + "description": "the ID of the host for the virtual machine", "name": "hostid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the affinity group", + "name": "name", "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 name where tag belongs to", - "name": "project", + "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 project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the type of the template", - "name": "templatetype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, - {}, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the template ID", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { @@ -43350,265 +43288,660 @@ "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" }, { - "description": "the 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 status of the template", - "name": "status", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "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" }, { - "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 service offering of the virtual machine", + "name": "serviceofferingname", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "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 date when this virtual machine was created", + "name": "created", + "type": "date" } ] }, { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", - "isasync": true, - "name": "assignToLoadBalancerRule", + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", "params": [ { - "description": "the ID of the load balancer rule", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "required": true, - "type": "uuid" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "vmidipmap", + "name": "listall", "required": false, - "since": "4.4", - "type": "map" + "type": "boolean" }, { - "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "description": "list static routes by state", "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", + "name": "state", "required": false, - "type": "list" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Updates a backup offering.", - "isasync": false, - "name": "updateBackupOffering", - "params": [ { - "description": "The name of the Backup Offering to be updated", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The description of the Backup Offering to be updated", + "description": "", "length": 255, - "name": "description", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The ID of the Backup Offering to be updated", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listBackupProviderOfferings,importBackupOffering,updateBackupOffering", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "Whether to allow user driven backups or not", + "description": "", "length": 255, - "name": "allowuserdrivenbackups", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" + }, + { + "description": "list static route by id", + "length": 255, + "name": "id", + "related": "listStaticRoutes", + "required": false, + "type": "uuid" + }, + { + "description": "list static routes by vpc id", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list static routes by gateway id", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], - "related": "listBackupProviderOfferings,importBackupOffering", + "related": "", "response": [ + {}, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" }, {}, { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" }, - {}, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "the list of resource tags associated with static route", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "name for the backup offering", - "name": "name", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "description for the backup offering", - "name": "description", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "zone ID", - "name": "zoneid", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "ID of the backup offering", - "name": "id", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "zone name", - "name": "zonename", + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", "type": "string" } - ], - "since": "4.16.0" + ] }, { - "description": "Lists all pending asynchronous jobs for the account.", + "description": "Lists all public ip addresses", "isasync": false, - "name": "listAsyncJobs", + "name": "listPublicIpAddresses", "params": [ { - "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.", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "listall", + "name": "allocatedonly", "required": false, "type": "boolean" }, { - "description": "The id of the management server", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -43617,6 +43950,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 by keyword", "length": 255, @@ -43625,1861 +43965,1865 @@ "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 display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "", + "description": "lists all public IP addresses by source network ID", "length": 255, - "name": "page", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "since": "4.13.0", + "type": "uuid" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "list only source NAT IP addresses", "length": 255, - "name": "startdate", + "name": "issourcenat", "required": false, - "type": "date" - } - ], - "related": "queryAsyncJobResult", - "response": [ - { - "description": "the async command executed", - "name": "cmd", - "type": "string" - }, - { - "description": " the completed date of the job", - "name": "completed", - "type": "date" - }, - { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "type": "boolean" }, { - "description": "the account that executed the async command", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "lists the specified IP address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" - }, - {}, - { - "description": " the created date of the job", - "name": "created", - "type": "date" - }, - { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": "the virtual network for the IP address", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "lists all public IP addresses associated to the network specified", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "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 instance/entity object related to the job", - "name": "jobinstancetype", + "description": "lists all public IP addresses by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "lists all public IP addresses by physical network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the user that executed the async command", - "name": "userid", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, - {}, - { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" - } - ] - }, - { - "description": "Archive one or more alerts.", - "isasync": false, - "name": "archiveAlerts", - "params": [ { - "description": "archive by alert type", + "description": "lists IP address by ID", "length": 255, - "name": "type", + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "list only IPs used for load balancing", "length": 255, - "name": "enddate", + "name": "forloadbalancing", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "the IDs of the alerts", + "description": "list only static NAT IP addresses", "length": 255, - "name": "ids", - "related": "listAlerts", + "name": "isstaticnat", "required": false, - "type": "list" + "type": "boolean" }, { - "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "startdate", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "date" + "type": "uuid" } ], + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the address", + "name": "project", "type": "string" - } - ] - }, - { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", - "params": [ + }, { - "description": "Force stop the VM. The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "response": [ - {}, + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, { - "description": "the state of the router", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", "name": "state", - "type": "state" + "type": "string" }, { - "description": "the id of the router", + "description": "public IP address id", "name": "id", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of resource tags associated with ip address", + "name": "tags", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, + {}, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the account associated with the router", - "name": "account", + "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 guest IP address for the router", - "name": "guestipaddress", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "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 VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + } + ] + }, + { + "description": "Updates an ISO file.", + "isasync": false, + "name": "updateIso", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "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 first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, "type": "boolean" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "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 network domain for the router", - "name": "networkdomain", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the domain associated with the router", - "name": "domain", - "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" + } + ], + "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "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 corresponding public network", - "name": "publicnetworkid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the name of the domain to which the template belongs", + "name": "domain", "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 list of nics associated with the router", - "name": "nic", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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 the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" - } - ] - }, - { - "description": "Adds a Brocade VCS Switch", - "isasync": true, - "name": "addBrocadeVcsDevice", - "params": [ + }, { - "description": "Credentials to access the Brocade VCS Switch API", - "length": 255, - "name": "username", - "required": true, + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", - "length": 255, - "name": "password", - "required": true, + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "Hostname of ip address of the Brocade VCS Switch.", - "length": 255, - "name": "hostname", - "required": true, + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "related": "listBrocadeVcsDevices", - "response": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "device name", - "name": "brocadedevicename", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, - {} - ] - }, - { - "description": "SP initiated SAML Single Sign On", - "isasync": false, - "name": "samlSso", - "params": [ { - "description": "Identity Provider Entity ID", - "length": 255, - "name": "idpid", - "required": true, - "type": "string" - } - ], - "related": "login", - "response": [ - { - "description": "user time zone", - "name": "timezone", + "description": "the UUID of the latest async job acting on 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 date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "last name of the user", - "name": "lastname", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, - {}, - { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" - }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "Username", - "name": "username", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "Is user registered", - "name": "registered", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "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": "Updates a security group", - "isasync": false, - "name": "updateSecurityGroup", - "params": [ - { - "description": "The ID of the security group.", - "length": 255, - "name": "id", - "related": "createSecurityGroup,updateSecurityGroup", - "required": true, - "type": "uuid" - }, { - "description": "The new name of the security group.", - "length": 255, + "description": "the template name", "name": "name", - "required": false, - "type": "string" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "createSecurityGroup", - "response": [ - {}, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", "type": "string" }, { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "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": "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" - } - ], - "type": "set" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the account owning the security group", + "description": "the account name to which the template belongs", "name": "account", "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" } - ], - "since": "4.14.0.0" + ] }, { - "description": "Creates a domain", + "description": "Lists OpenDyalight controllers", "isasync": false, - "name": "createDomain", + "name": "listOpenDaylightControllers", "params": [ { - "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", + "description": "the Physical Network ID", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "Network domain for networks in the domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - }, - { - "description": "creates domain with this name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Domain UUID, required for adding domain from another Region", + "description": "the ID of a OpenDaylight Controller", "length": 255, - "name": "domainid", + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "listDomainChildren,listDomains,listDomains", + "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ - { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" - }, {}, - { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, - { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, - {}, - { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "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", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the controller", + "name": "id", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the path of the domain", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, + } + ] + }, + { + "description": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", + "params": [ { - "description": "the ID of the domain", - "name": "id", + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "NAT support of the BigSwitch BCF Controller.", + "length": 255, + "name": "nat", + "required": true, + "type": "boolean" }, { - "description": "the state of the domain", - "name": "state", + "description": "Password of the BigSwitch BCF Controller.", + "length": 255, + "name": "password", + "required": true, "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, + } + ], + "related": "listBigSwitchBcfDevices", + "response": [ + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the name of the domain", - "name": "name", - "type": "string" + "description": "NAT support", + "name": "nat", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the controller password", + "name": "password", "type": "string" }, + {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the controller username", + "name": "username", "type": "string" - }, - { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" } - ] + ], + "since": "4.6.0" }, { - "description": "Deleting resource tag(s)", + "description": "Deletes a counter for VM auto scaling", "isasync": true, - "name": "deleteTags", + "name": "deleteCounter", "params": [ { - "description": "Delete tags matching key/value pairs", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "Delete tag by resource type", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - }, - { - "description": "Delete tags for resource id(s)", + "description": "the ID of the counter", "length": 255, - "name": "resourceids", + "name": "id", + "related": "createCounter,listCounters", "required": true, - "type": "list" + "type": "uuid" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "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.0.0" + ] }, { - "description": "create Tungsten-Fabric tag type", + "description": "Changes the default NIC on a VM", "isasync": true, - "name": "createTungstenFabricTagType", + "name": "updateDefaultNicForVirtualMachine", "params": [ { - "description": "Tungsten-Fabric tag type name", + "description": "Virtual Machine ID", "length": 255, - "name": "name", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "NIC ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "nicid", + "related": "", "required": true, "type": "uuid" } ], - "related": "listTungstenFabricTagType", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - {}, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "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 amount of the vm's CPU currently used", + "name": "cpuused", + "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": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Username", - "length": 255, - "name": "username", - "required": true, - "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 domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", - "length": 255, - "name": "domain", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { - "description": "User ID", - "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": "Domain ID that the user belongs to", - "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "last name of the user", - "name": "lastname", - "type": "string" + "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 NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, {}, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Username", - "name": "username", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, {}, { - "description": "user time zone", - "name": "timezone", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" - } - ] - }, - { - "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", - "isasync": true, - "name": "restartNetwork", - "params": [ + }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", - "length": 255, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "The ID of the network to restart.", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "Turn the network into a network with redundant routers.", - "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" - } - ], - "response": [ - {}, - {}, + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists all hypervisor capabilities.", - "isasync": false, - "name": "listHypervisorCapabilities", - "params": [ - { - "description": "ID of the hypervisor capability", - "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", - "required": false, - "type": "uuid" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -45487,226 +45831,268 @@ "type": "string" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, - {}, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "hypervisortype" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds backup image store.", - "isasync": false, - "name": "addImageStore", - "params": [ + }, { - "description": "the URL for the image store", - "length": 2048, - "name": "url", - "required": false, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the Zone ID for the image store", - "length": 255, + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + {}, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" - } - ], - "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the url of the image store", - "name": "url", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "Revoke a direct download certificate from hosts in a zone", + "description": "Generate DRS plan for a cluster", "isasync": false, - "name": "revokeTemplateDirectDownloadCertificate", + "name": "generateClusterDrsPlan", "params": [ { - "description": "(optional) zone to revoke certificate", + "description": "the ID of the Cluster", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "migrations", "required": false, - "type": "uuid" + "type": "integer" + } + ], + "related": "executeClusterDrsPlan", + "response": [ + {}, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "(optional) hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "id of the certificate", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, + {}, { - "description": "(optional) alias of the SSL certificate", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "provisionTemplateDirectDownloadCertificate", - "response": [ + "description": "List of migrations", + "name": "migrations", + "type": "list" + }, { - "description": "the name of the host", - "name": "hostname", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -45714,213 +46100,250 @@ }, {}, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", - "type": "string" - }, - { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" } ], - "since": "4.13" + "since": "4.19.0" }, { - "description": "Syncs capabilities of storage pools", + "description": "Deletes a user for an account", "isasync": false, - "name": "updateStorageCapabilities", + "name": "deleteUser", "params": [ { - "description": "Storage pool id", + "description": "id of the user to be deleted", "length": 255, "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": true, "type": "uuid" } ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the name of the storage pool", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the 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 storage pool type", - "name": "type", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ { - "description": "the tags for the storage pool", - "name": "tags", + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "length": 255, + "name": "action", + "required": true, "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "long" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", + "response": [ { - "description": "the Pod ID of the storage pool", - "name": "podid", + "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", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Issues a client certificate using configured or provided CA plugin", + "isasync": true, + "name": "issueCertificate", + "params": [ + { + "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": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", + "length": 65535, + "name": "csr", + "required": false, "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "Comma separated list of IP addresses, the certificate should be issued for", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + } + ], + "related": "listCaCertificate", + "response": [ { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "Private key for the certificate", + "name": "privatekey", "type": "string" }, + {}, { - "description": "the storage pool path", - "name": "path", + "description": "The client certificate", + "name": "certificate", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - } + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" + }, + {} ], - "since": "4.16.0" + "since": "4.11.0" }, { - "description": "Delete Project roles in CloudStack", + "description": "Deletes network device.", "isasync": false, - "name": "deleteProjectRole", + "name": "deleteNetworkDevice", "params": [ { - "description": "ID of the project from where the role is to be deleted", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "ID of the project role to be deleted", + "description": "Id of network device to delete", "length": 255, "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -45932,115 +46355,81 @@ "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.15.0" + }, + {} + ] }, { - "description": "Changes ownership of a Volume from one account to another.", + "description": "Updates image store read-only status", "isasync": false, - "name": "assignVolume", + "name": "updateImageStore", "params": [ { - "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "The ID of the volume to be reassigned.", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "readonly", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", + "description": "Image Store UUID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -46049,138 +46438,182 @@ "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the url of the image store", + "name": "url", "type": "string" }, + {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the image store", + "name": "name", "type": "string" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Creates a port forwarding rule", + "isasync": true, + "name": "createPortForwardingRule", + "params": [ { - "description": "the account associated with the disk volume", - "name": "account", + "description": "VM guest nic secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the starting port of port forwarding rule's public port range", + "length": 255, + "name": "publicport", + "required": true, + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "publicendport", + "required": false, + "type": "integer" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "privateendport", + "required": false, + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the virtual machine for the port forwarding rule", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "response": [ + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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 list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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": "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": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -46189,598 +46622,562 @@ "type": "string" } ], - "type": "set" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "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 disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "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": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "type": "list" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of the disk volume", + "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "4.18.0.0" + ] }, { - "description": "Deletes a userdata", - "isasync": false, - "name": "deleteUserData", + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", "params": [ { - "description": "an optional project for the userdata", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "the ID of the containing domain", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, "type": "uuid" }, { - "description": "the ID of the Userdata", + "description": "the ID of the zone", "length": 255, - "name": "id", - "related": "", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "an optional account for the userdata. Must be used with domainId.", + "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": "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": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" - } - ], - "since": "4.18" + }, + { + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" + }, + { + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + { + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" + }, + {}, + {} + ] }, { - "description": "Create a quota balance statement", + "description": "load template into primary storage", "isasync": false, - "name": "quotaBalance", + "name": "prepareTemplate", "params": [ { - "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "description": "List usage records for the specified account", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "Account Id for which statement needs to be generated", + "description": "zone ID of the template to be prepared in primary storage(s).", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", + "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": "startdate", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "date" + "type": "uuid" } ], - "related": "", + "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "account name", - "name": "account", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "usage type", - "name": "type", - "type": "int" + "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": "domain id", - "name": "domain", - "type": "long" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "usage unit", - "name": "unit", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "account id", - "name": "accountid", - "type": "long" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "usage type name", - "name": "name", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" - } - ], - "since": "4.7.0" - }, - { - "description": "Get SolidFire Account ID", - "isasync": false, - "name": "getSolidFireAccountId", - "params": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "CloudStack Account UUID", - "length": 255, - "name": "accountid", - "required": true, + "description": "the template ID", + "name": "id", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", - "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ] - }, - { - "description": "Lists all network services provided by CloudStack or for the given Provider.", - "isasync": false, - "name": "listSupportedNetworkServices", - "params": [ { - "description": "network service provider name", - "length": 255, - "name": "provider", - "required": false, + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "network service name to list providers and capabilities of", - "length": 255, - "name": "service", - "required": false, + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the provider name", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "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": "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" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the capability value", + "description": "tag value", "name": "value", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the service name", - "name": "name", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template display text", + "name": "displaytext", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists role permissions", - "isasync": false, - "name": "listRolePermissions", - "params": [ + }, { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the role permission", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, {}, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, - {} - ], - "since": "4.9.0" - }, - { - "description": "Deletes a particular ingress rule from this security group", - "isasync": true, - "name": "revokeSecurityGroupIngress", - "params": [ { - "description": "The ID of the ingress rule", - "length": 255, - "name": "id", - "related": "authorizeSecurityGroupIngress", - "required": true, + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + } + ] + }, + { + "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "isasync": true, + "name": "assignToLoadBalancerRule", + "params": [ + { + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "length": 255, + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" + }, + { + "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "list" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "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", @@ -46793,54 +47190,53 @@ }, {}, { - "description": "the UUID of the latest async job acting on 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 dedicated guest vlan ranges", + "description": "Lists all pending asynchronous jobs for the account.", "isasync": false, - "name": "listDedicatedGuestVlanRanges", + "name": "listAsyncJobs", "params": [ { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the dedicated guest vlan range", + "description": "The id of the management server", "length": 255, - "name": "guestvlanrange", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "page", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "project who will own the guest VLAN range", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -46850,73 +47246,80 @@ "type": "integer" }, { - "description": "physical network id of the guest VLAN range", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "zone of the guest VLAN range", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" - }, - { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "", + "related": "queryAsyncJobResult", "response": [ { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" + }, + { + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, {}, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": " the created date of the job", + "name": "created", + "type": "date" }, + {}, { - "description": "the project name of the guest vlan range", - "name": "project", - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", - "type": "string" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" + }, + { + "description": "the result code for the job", + "name": "jobresultcode", "type": "integer" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the async command executed", + "name": "cmd", + "type": "string" + }, + { + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { @@ -46925,86 +47328,86 @@ "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" + "description": "the account that executed the async command", + "name": "account", + "type": "string" }, - {}, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" + }, + { + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the account id that executed the async command", + "name": "accountid", + "type": "string" + }, + { + "description": "the result type", + "name": "jobresulttype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the user that executed the async command", + "name": "userid", "type": "string" } ] }, { - "description": "Adds a network serviceProvider to a physical network", - "isasync": true, - "name": "addNetworkServiceProvider", + "description": "Archive one or more alerts.", + "isasync": false, + "name": "archiveAlerts", "params": [ { - "description": "the Physical Network ID to add the provider to", + "description": "archive by alert type", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "type", + "required": false, + "type": "string" }, { - "description": "the list of services to be enabled for this physical network service provider", + "description": "the IDs of the alerts", "length": 255, - "name": "servicelist", + "name": "ids", + "related": "listAlerts", "required": false, "type": "list" }, { - "description": "the name for the physical network service provider", + "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": "name", - "required": true, - "type": "string" + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the destination Physical Network ID to bridge to", + "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": "destinationphysicalnetworkid", - "related": "createPhysicalNetwork", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" } ], - "related": "listNetworkServiceProviders,listTrafficTypes", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -47012,117 +47415,92 @@ "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists all network ACL items", + "description": "Lists all Buckets.", "isasync": false, - "name": "listNetworkACLs", + "name": "listBuckets", "params": [ { - "description": "list network ACL items by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list network ACL items by ACL ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "account", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "string" + "type": "list" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the bucket", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "listBuckets", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "list network ACL items by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "list network ACL items by protocol", + "description": "the name of the bucket", "length": 255, - "name": "protocol", + "name": "name", "required": false, "type": "string" }, { - "description": "list network ACL items by action", + "description": "List by keyword", "length": 255, - "name": "action", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -47132,70 +47510,64 @@ "type": "boolean" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "related": "", "response": [ {}, { - "description": "the ID of the ACL Item", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ID of the Bucket", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "Bucket URL", + "name": "url", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Bucket Quota in GB", + "name": "quota", "type": "integer" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -47207,13 +47579,13 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -47221,152 +47593,211 @@ "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": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "name of the Bucket", + "name": "name", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "Bucket Encryption", + "name": "encryption", "type": "boolean" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "Object storage provider", + "name": "provider", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "Bucket Secret Key", + "name": "usersecretkey", + "type": "string" }, - {}, { - "description": "Number of the ACL Item", - "name": "number", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "the account associated with the Bucket", + "name": "account", "type": "string" + }, + {}, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" } - ] + ], + "since": "4.19.0" }, { - "description": "Delete site to site vpn gateway", - "isasync": true, - "name": "deleteVpnGateway", + "description": "Deletes a Cisco Vnmc controller", + "isasync": false, + "name": "deleteCiscoVnmcResource", "params": [ { - "description": "id of customer gateway", + "description": "Cisco Vnmc resource ID", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "name": "resourceid", + "related": "listCiscoVnmcResources", "required": true, "type": "uuid" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "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": "Marks a quota tariff as removed.", + "description": "Creates a secondary storage selector, described by the heuristic rule.", "isasync": false, - "name": "quotaTariffDelete", + "name": "createSecondaryStorageSelector", "params": [ { - "description": "ID of the quota tariff", + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" + }, + { + "description": "The name identifying the heuristic rule.", "length": 255, - "name": "id", - "related": "quotaTariffCreate", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The description of the heuristic rule.", + "length": 255, + "name": "description", + "required": true, + "type": "string" + }, + { + "description": "The zone in which the heuristic rule will be applied.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "length": 255, + "name": "type", "required": true, "type": "string" } ], + "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -47374,2302 +47805,2340 @@ "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.18.0.0" - }, - { - "description": "Creates a service offering.", - "isasync": false, - "name": "createServiceOffering", - "params": [ - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "length": 255, - "name": "hypervisorsnapshotreserve", - "required": false, - "since": "4.4", - "type": "integer" + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" }, { - "description": "the HA for the service offering", - "length": 255, - "name": "offerha", - "required": false, - "type": "boolean" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "description": "io requests write rate of the disk offering", - "length": 255, - "name": "iopswriterate", - "required": false, - "type": "long" + "description": "Description of the heuristic.", + "name": "description", + "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "length": 255, - "name": "diskofferingstrictness", - "required": false, - "since": "4.17", - "type": "boolean" + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" }, { - "description": "the tags for this service offering.", - "length": 255, - "name": "tags", - "required": false, + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Stops an Internal LB vm.", + "isasync": true, + "name": "stopInternalLoadBalancerVM", + "params": [ + { + "description": "the ID of the internal lb vm", "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" + "name": "id", + "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" }, { - "description": "The display text of the service offering, defaults to 'name'.", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, - "name": "displaytext", + "name": "forced", "required": false, + "type": "boolean" + } + ], + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the CPU speed of the service offering in MHz.", - "length": 255, - "name": "cpuspeed", - "required": false, - "type": "integer" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "Whether service offering size is custom or not", - "length": 255, - "name": "customized", - "required": false, - "since": "4.13", - "type": "boolean" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "the total memory of the service offering in MB", - "length": 255, - "name": "memory", - "required": false, - "type": "integer" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "The minimum memory size of the custom service offering in MB", - "length": 255, - "name": "minmemory", - "required": false, - "since": "4.13", + "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": "min iops of the compute offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.4", - "type": "long" + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "details for planner, used to store specific parameters", - "length": 255, - "name": "serviceofferingdetails", - "required": false, - "type": "map" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", - "length": 255, - "name": "deploymentplanner", - "required": false, + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the CPU number of the service offering", - "length": 255, - "name": "cpunumber", - "required": false, - "type": "integer" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the Root disk size in GB.", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.15", - "type": "long" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "restrict the CPU usage to committed service offering", - "length": 255, - "name": "limitcpuuse", - "required": false, + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "is this a system vm offering", - "length": 255, - "name": "issystem", - "required": false, - "type": "boolean" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", - "length": 255, - "name": "mincpunumber", - "required": false, - "since": "4.13", - "type": "integer" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "The maximum memory size of the custom service offering in MB", - "length": 255, - "name": "maxmemory", - "required": false, - "since": "4.13", - "type": "integer" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], "type": "list" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", - "length": 255, - "name": "maxcpunumber", - "required": false, - "since": "4.13", - "type": "integer" - }, - { - "description": "the ID of the disk offering to which service offering should be mapped", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "whether compute offering iops is custom or not", - "length": 255, - "name": "customizediops", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "max iops of the compute offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.4", - "type": "long" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "type": "long" + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "type": "long" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "VMs using this offering require root volume encryption", - "length": 255, - "name": "encryptroot", - "required": false, - "since": "4.18", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, - "type": "long" - }, - { - "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", - "length": 255, - "name": "isvolatile", - "required": false, - "type": "boolean" + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "required": false, - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", - "length": 255, - "name": "storagepolicy", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "type": "long" + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { - "description": "the name of the service offering", - "length": 255, - "name": "name", - "required": true, + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" - } - ], - "related": "updateServiceOffering,listServiceOfferings", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hostname for the router", + "name": "hostname", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "VPC the router belongs to", + "name": "vpcid", + "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 name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the state of the router", + "name": "state", + "type": "state" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "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 template ID for the router", + "name": "templateid", "type": "string" + } + ] + }, + { + "description": "Adds a Brocade VCS Switch", + "isasync": true, + "name": "addBrocadeVcsDevice", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "Hostname of ip address of the Brocade VCS Switch.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "username", + "required": true, + "type": "string" + } + ], + "related": "listBrocadeVcsDevices", + "response": [ { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, - {}, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", + "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": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "device name", + "name": "brocadedevicename", + "type": "string" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the provider", + "name": "provider", "type": "string" - }, + } + ] + }, + { + "description": "Updates a security group", + "isasync": false, + "name": "updateSecurityGroup", + "params": [ { - "description": "the tags for the service offering", - "name": "storagetags", + "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 name of the service offering", + "description": "The new name of the security group.", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" - }, - { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, + "description": "The ID of the security group.", + "length": 255, + "name": "id", + "related": "createSecurityGroup,updateSecurityGroup", + "required": true, + "type": "uuid" + } + ], + "related": "createSecurityGroup", + "response": [ { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the account owning the security group", + "name": "account", "type": "string" }, + {}, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, + {}, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.14.0.0" }, { - "description": "Copies a template from one zone to another.", - "isasync": true, - "name": "copyTemplate", + "description": "Creates a domain", + "isasync": false, + "name": "createDomain", "params": [ { - "description": "ID of the zone the template is being copied to.", + "description": "Domain UUID, required for adding domain from another Region", "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "Network domain for networks in the domain", "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkdomain", "required": false, - "type": "list" + "type": "string" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "creates domain with this name", "length": 255, - "name": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "Template ID.", + "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": "id", - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, + "name": "parentdomainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listDomainChildren,listDomains,listDomains", "response": [ { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "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 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 domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the state of the domain", + "name": "state", + "type": "string" }, - {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, + {}, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the name of the domain", + "name": "name", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" - }, - {} + } ] }, { - "description": "lists network that are using a nicira nvp device", - "isasync": false, - "name": "listNiciraNvpDeviceNetworks", + "description": "Deleting resource tag(s)", + "isasync": true, + "name": "deleteTags", "params": [ { - "description": "nicira nvp device ID", - "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, - "type": "uuid" - }, - { - "description": "", + "description": "Delete tags matching key/value pairs", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "", + "description": "Delete tag by resource type", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "resourcetype", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "Delete tags for resource id(s)", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "resourceids", + "required": true, + "type": "list" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the network owner", - "name": "domain", + "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": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "Tungsten-Fabric tag type name", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listTungstenFabricTagType", + "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "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": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "Tungsten-Fabric tag type name", + "name": "name", "type": "string" }, + {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", + "isasync": true, + "name": "restartNetwork", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "length": 255, + "name": "livepatch", + "required": false, + "since": "4.17.0", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "The ID of the network to restart.", + "length": 255, + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "Turn the network into a network with redundant routers.", + "length": 255, + "name": "makeredundant", + "required": false, + "since": "4.11.1", + "type": "boolean" }, - {}, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "If cleanup old network elements", + "length": 255, + "name": "cleanup", + "required": false, "type": "boolean" - }, + } + ], + "response": [ + {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Username", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "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" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "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": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "length": 255, + "name": "domainId", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "user time zone", + "name": "timezone", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, + {}, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "last name of the user", + "name": "lastname", + "type": "string" }, + {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "Domain ID that the user belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Is user registered", + "name": "registered", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "User ID", + "name": "userid", + "type": "string" }, { - "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": "acl type - access type to the network", - "name": "acltype", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", + "type": "string" + } + ] + }, + { + "description": "Lists all hypervisor capabilities.", + "isasync": false, + "name": "listHypervisorCapabilities", + "params": [ + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities", + "required": false, + "type": "uuid" }, { - "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, + {}, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, + {}, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Adds backup image store.", + "isasync": false, + "name": "addImageStore", + "params": [ + { + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the name for the image store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the image store provider name", + "length": 255, + "name": "provider", + "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": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the URL for the image store", + "length": 2048, + "name": "url", + "required": false, "type": "string" + } + ], + "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "response": [ + {}, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the id of the network", - "name": "id", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ] + ], + "since": "4.2.0" }, { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "description": "Revoke a direct download certificate from hosts in a zone", "isasync": false, - "name": "assignVirtualMachine", + "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "description": "(optional) hypervisor type", "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "hypervisor", "required": false, - "type": "list" + "type": "string" }, { - "description": "account name of the new VM owner.", + "description": "(optional) alias of the SSL certificate", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "description": "(optional) zone to revoke certificate", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "domain id of the new VM owner.", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "id of the VM to be moved", + "description": "id of the certificate", "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, + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "required": false, "type": "uuid" + } + ], + "related": "provisionTemplateDirectDownloadCertificate", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "an optional project for the new VM owner.", + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the host", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", + "type": "string" + } + ], + "since": "4.13" + }, + { + "description": "Syncs capabilities of storage pools", + "isasync": false, + "name": "updateStorageCapabilities", + "params": [ + { + "description": "Storage pool id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "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", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the storage pool type", + "name": "type", "type": "string" }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "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": "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": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "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": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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 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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + } + ], + "since": "4.16.0" + }, + { + "description": "Delete Project roles in CloudStack", + "isasync": false, + "name": "deleteProjectRole", + "params": [ + { + "description": "ID of the project from where the role is to be deleted", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "ID of the project role to be deleted", + "length": 255, + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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.15.0" + }, + { + "description": "Changes ownership of a Volume from one account to another.", + "isasync": false, + "name": "assignVolume", + "params": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the volume to be reassigned.", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "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 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": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of the virtual machine", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "name of the disk volume", "name": "name", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, + {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -49677,23 +50146,78 @@ "name": "templatedisplaytext", "type": "string" }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -49702,13 +50226,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -49722,468 +50246,281 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the project name of the vm", + "description": "the project name of the vpn", "name": "project", "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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, - {}, - {}, { - "description": "the name of the disk offering of the virtual machine", + "description": "name of the disk offering", "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "ID of the disk volume", "name": "id", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "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 when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" + } + ], + "since": "4.18.0.0" + }, + { + "description": "Deletes a userdata", + "isasync": false, + "name": "deleteUserData", + "params": [ + { + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - } + {}, + {} ], - "since": "3.0.0" + "since": "4.18" }, { - "description": " delete a BigSwitch BCF Controller device", - "isasync": true, - "name": "deleteBigSwitchBcfDevice", + "description": "Get SolidFire Account ID", + "isasync": false, + "name": "getSolidFireAccountId", "params": [ { - "description": "BigSwitch device ID", + "description": "CloudStack Account UUID", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "accountid", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, + "type": "string" } ], + "related": "", "response": [ + {}, + { + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" + }, + {}, { "description": "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.6.0" + } + ] }, { - "description": "configures a netscaler load balancer device", - "isasync": true, - "name": "configureNetscalerLoadBalancer", + "description": "Lists role permissions", + "isasync": false, + "name": "listRolePermissions", "params": [ { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", + "description": "ID of the role", "length": 255, - "name": "lbdevicededicated", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "boolean" - }, - { - "description": "Netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, "type": "uuid" - }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "length": 255, - "name": "podids", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "list" - }, - { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "lbdevicecapacity", - "required": false, - "type": "long" - }, - { - "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", - "length": 255, - "name": "inline", - "required": false, - "type": "boolean" } ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "related": "", "response": [ - {}, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - {}, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" - }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, + {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "device state", - "name": "lbdevicestate", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, + {}, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the description of the role permission", + "name": "description", + "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists all available ovs elements.", + "description": "Lists all network services provided by CloudStack or for the given Provider.", "isasync": false, - "name": "listOvsElements", + "name": "listSupportedNetworkServices", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list ovs elements by network service provider id", + "description": "List by keyword", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders,listTrafficTypes", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list ovs elements by id", + "description": "network service name to list providers and capabilities of", "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", + "name": "service", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network offerings by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "network service provider name", "length": 255, - "name": "keyword", + "name": "provider", "required": false, "type": "string" }, @@ -50195,81 +50532,104 @@ "type": "integer" } ], - "related": "configureOvsElement", + "related": "", "response": [ { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" }, {}, {}, - { - "description": "the id of the ovs", - "name": "id", - "type": "string" - }, - { - "description": "the account associated with the provider", - "name": "account", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" - }, - { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "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" } - ] + ], + "since": "3.0.0" }, { - "description": "delete Tungsten-Fabric service group", + "description": "Deletes a particular ingress rule from this security group", "isasync": true, - "name": "deleteTungstenFabricServiceGroup", + "name": "revokeSecurityGroupIngress", "params": [ { - "description": "the ID of zone", + "description": "The ID of the ingress rule", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "authorizeSecurityGroupIngress", "required": true, "type": "uuid" - }, - { - "description": "the uuid of Tungsten-Fabric service group", - "length": 255, - "name": "servicegroupuuid", - "required": true, - "type": "string" } ], "response": [ @@ -50278,12 +50638,12 @@ "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", @@ -50298,92 +50658,96 @@ ] }, { - "description": "associate a profile to a blade", - "isasync": true, - "name": "associateUcsProfileToBlade", + "description": "Lists dedicated guest vlan ranges", + "isasync": false, + "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "blade id", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", - "required": true, + "name": "id", + "related": "listDedicatedGuestVlanRanges", + "required": false, "type": "uuid" }, { - "description": "ucs manager id", + "description": "List by keyword", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "profile dn", + "description": "the dedicated guest vlan range", "length": 255, - "name": "profiledn", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "ucs manager id", - "name": "ucsmanagerid", + "name": "guestvlanrange", + "required": false, "type": "string" }, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" + "description": "physical network id of the guest VLAN range", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "ucs blade id", - "name": "id", - "type": "string" + "description": "zone of the guest VLAN range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "ucs blade dn", - "name": "bladedn", - "type": "string" + "description": "project who will own the guest VLAN range", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, - {} - ] - }, - { - "description": "Checks the 2FA code for the user.", - "isasync": false, - "name": "validateUserTwoFactorAuthenticationCode", - "params": [ { - "description": "two factor authentication code", + "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": "codefor2fa", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { @@ -50391,121 +50755,142 @@ "name": "jobid", "type": "string" }, + { + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" }, {}, - {} - ], - "since": "4.18.0" + {}, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + } + ] }, { - "description": "Deletes user from the project", + "description": "Adds a network serviceProvider to a physical network", "isasync": true, - "name": "deleteUserFromProject", + "name": "addNetworkServiceProvider", "params": [ { - "description": "ID of the project to remove the user from", + "description": "the Physical Network ID to add the provider to", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, "type": "uuid" }, { - "description": "Id of the user to be removed from the project", + "description": "the name for the physical network service provider", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "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" + }, + { + "description": "the destination Physical Network ID to bridge to", + "length": 255, + "name": "destinationphysicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, "type": "uuid" } ], + "related": "listNetworkServiceProviders,listTrafficTypes", "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": "state of the network provider", + "name": "state", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.15.0" - }, - { - "description": "Starts a router.", - "isasync": false, - "name": "getRouterHealthCheckResults", - "params": [ + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { - "description": "the ID of the router", - "length": 255, - "name": "routerid", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", - "length": 255, - "name": "performfreshchecks", - "required": false, + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" - } - ], - "related": "", - "response": [ + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, + {}, { - "description": "the id of the router", - "name": "routerid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the id of the router", - "name": "healthchecks", - "type": "list" - }, - {}, - {} + "description": "the provider name", + "name": "name", + "type": "string" + } ], - "since": "4.14.0" + "since": "3.0.0" }, { - "description": "list control center", + "description": "Lists all network ACL items", "isasync": false, - "name": "listNetscalerControlCenter", + "name": "listNetworkACLs", "params": [ { "description": "List by keyword", @@ -50515,843 +50900,828 @@ "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list network ACL items by protocol", "length": 255, - "name": "page", + "name": "protocol", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "uuid", - "name": "uuid", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "username", - "name": "username", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "num_retries", - "name": "numretries", - "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", - "name": "id", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ncc_ip", - "name": "ipaddress", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list network ACL items by action", + "length": 255, + "name": "action", + "required": false, "type": "string" - } - ] - }, - { - "description": "Resizes a volume", - "isasync": true, - "name": "resizeVolume", - "params": [ + }, { - "description": "the ID of the disk volume", + "description": "Lists network ACL Item with the specified ID", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "required": false, "type": "uuid" }, { - "description": "New maximum number of IOPS", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "maxiops", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "Verify OK to Shrink", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "shrinkok", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "New volume size in GB", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "size", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { - "description": "New minimum number of IOPS", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "miniops", + "name": "traffictype", "required": false, - "type": "long" + "type": "string" }, { - "description": "new disk offering id", + "description": "list network ACL items by network ID", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, + {}, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the ACL Item", + "name": "id", "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", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the 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": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {} + ] + }, + { + "description": "Delete site to site vpn gateway", + "isasync": true, + "name": "deleteVpnGateway", + "params": [ { - "description": "ID of the disk volume", + "description": "id of customer gateway", + "length": 255, "name": "id", - "type": "string" - }, + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Creates a service offering.", + "isasync": false, + "name": "createServiceOffering", + "params": [ { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "max iops of the compute offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.4", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", + "required": false, + "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 system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "length": 255, + "name": "systemvmtype", + "required": false, "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the tags for this service offering.", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the Root disk size in GB.", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.15", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "length": 255, + "name": "hypervisorsnapshotreserve", + "required": false, + "since": "4.4", + "type": "integer" }, { - "description": "the 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/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": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the CPU speed of the service offering in MHz.", + "length": 255, + "name": "cpuspeed", + "required": false, + "type": "integer" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "length": 255, + "name": "maxcpunumber", + "required": false, + "since": "4.13", + "type": "integer" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "The display text of the service offering, defaults to 'name'.", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "VMs using this offering require root volume encryption", + "length": 255, + "name": "encryptroot", + "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "list" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "length": 255, + "name": "provisioningtype", + "required": false, "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "length": 255, + "name": "deploymentplanner", + "required": false, "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the total memory of the service offering in MB", + "length": 255, + "name": "memory", + "required": false, + "type": "integer" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "restrict the CPU usage to committed service offering", + "length": 255, + "name": "limitcpuuse", + "required": false, "type": "boolean" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "details for planner, used to store specific parameters", + "length": 255, + "name": "serviceofferingdetails", + "required": false, + "type": "map" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "whether compute offering iops is custom or not", + "length": 255, + "name": "customizediops", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "The minimum memory size of the custom service offering in MB", + "length": 255, + "name": "minmemory", + "required": false, + "since": "4.13", + "type": "integer" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "Whether service offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "since": "4.13", + "type": "boolean" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "length": 255, + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", + "type": "uuid" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the name of the service offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "min iops of the compute offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.4", "type": "long" }, - {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "length": 255, + "name": "mincpunumber", + "required": false, + "since": "4.13", + "type": "integer" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "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": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, "type": "long" - } - ] - }, - { - "description": "Deletes affinity group", - "isasync": true, - "name": "deleteAffinityGroup", - "params": [ + }, { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "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": "name", + "name": "isvolatile", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the project of the affinity group", + "description": "the HA for the service offering", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "offerha", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the domain ID of account owning the affinity group", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "iopswriterate", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "length (in seconds) of the burst", "length": 255, - "name": "id", - "related": "", + "name": "iopsreadratemaxlength", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the account of the affinity group. Must be specified with domain ID", + "description": "the CPU number of the service offering", "length": 255, - "name": "account", + "name": "cpunumber", "required": false, - "type": "string" - } - ], - "response": [ - {}, + "type": "integer" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the disk offering to which service offering should be mapped", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Deletes a network offering.", - "isasync": false, - "name": "deleteNetworkOffering", - "params": [ + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" + }, { - "description": "the ID of the network offering", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "id", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "name": "maxmemory", + "required": false, + "since": "4.13", + "type": "integer" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "type": "long" } ], + "related": "updateServiceOffering,listServiceOfferings", "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 service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "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" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a Network Service Provider.", - "isasync": true, - "name": "deleteNetworkServiceProvider", - "params": [ - { - "description": "the ID of the network service provider", - "length": 255, - "name": "id", - "related": "listNetworkServiceProviders,listTrafficTypes", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Dedicates a Pod.", - "isasync": true, - "name": "dedicatePod", - "params": [ - { - "description": "the ID of the Pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" - } - ], - "related": "listDedicatedPods", - "response": [ - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, - {}, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", - "type": "string" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" - } - ] - }, - { - "description": "List network devices", - "isasync": false, - "name": "listNetworkDevice", - "params": [ + }, { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": false, - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "addNetworkDevice", - "response": [ + "description": "is this a system vm offering", + "name": "issystem", + "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/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" }, - {}, { - "description": "the ID of the network device", - "name": "id", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, - {} - ] - }, - { - "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", - "isasync": true, - "name": "updateStorageNetworkIpRange", - "params": [ { - "description": "the beginning IP address", - "length": 255, - "name": "startip", - "required": false, - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the netmask for storage network", - "length": 255, - "name": "netmask", - "required": false, + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "Optional. the vlan the ip range sits on", - "length": 255, - "name": "vlan", - "required": false, - "type": "integer" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "UUID of storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", - "response": [ + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" + }, { - "description": "the end ip of the storage network IP range", - "name": "endip", - "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", @@ -51359,439 +51729,331 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, - {}, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "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 or VID of the VLAN.", - "name": "vlan", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, { - "description": "the uuid of storage network IP range.", - "name": "id", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "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 gateway of the storage network IP range", - "name": "gateway", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "query simulator mock", - "isasync": false, - "name": "querySimulatorMock", - "params": [ + }, { - "description": "id of the configured mock", - "length": 255, - "name": "id", - "required": false, + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the Zone ID scope of the mock", - "name": "zoneid", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the agent command to be mocked", - "name": "name", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Cluster ID scope of the mock", - "name": "clusterid", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the mock ID", - "name": "id", - "type": "long" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, - {}, { - "description": "the Host ID scope of the mock", - "name": "hostid", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "the Pod ID scope of the mock", - "name": "podid", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "number of times mock is executed, if not specified then mock remains active till cleaned up", - "name": "count", - "type": "integer" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" } ] }, { - "description": "Lists Project roles in CloudStack", - "isasync": false, - "name": "listProjectRoles", + "description": "Copies a template from one zone to another.", + "isasync": true, + "name": "copyTemplate", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List project role by project ID.", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", + "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": "keyword", + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "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": "page", + "name": "sourcezoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List project role by project role ID.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List project role by project role name.", + "description": "Template ID.", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" } ], - "related": "createProjectRole,updateProjectRole", + "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the name of the role", - "name": "name", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, - {}, { - "description": "the id of the project", - "name": "projectid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" - } - ], - "since": "4.15.0" - }, - { - "description": "Removes an OpenDyalight controler", - "isasync": true, - "name": "deleteOpenDaylightController", - "params": [ - { - "description": "OpenDaylight Controller ID", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController", - "required": true, - "type": "uuid" - } - ], - "related": "addOpenDaylightController", - "response": [ - {}, + }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "the project name of the template", + "name": "project", "type": "string" }, - {}, { - "description": "the name assigned to the controller", - "name": "name", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "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": "device id of the controller", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Updates attributes of a template.", - "isasync": false, - "name": "updateTemplate", - "params": [ - { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the format for the image", - "length": 255, - "name": "format", - "required": false, + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the type of the template", - "length": 255, - "name": "templatetype", - "required": false, + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "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, + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "description": "the status of the template", + "name": "status", + "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "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": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "the type of the template", - "name": "templatetype", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "checksum of the template", - "name": "checksum", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the 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": "the template name", + "name": "name", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -51799,8 +52061,8 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -51808,14 +52070,19 @@ "name": "domainid", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -51824,13 +52091,8 @@ "type": "string" }, { - "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" }, { @@ -51839,32 +52101,23 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + {}, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "true if the template is managed across all Zones, false otherwise", @@ -51872,1384 +52125,1705 @@ "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, - {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" - }, + } + ] + }, + { + "description": "lists network that are using a nicira nvp device", + "isasync": false, + "name": "listNiciraNvpDeviceNetworks", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "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 users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - } - ] - }, - { - "description": "Creates a VLAN IP range.", - "isasync": false, - "name": "createVlanIpRange", - "params": [ + "description": "the details of the network", + "name": "details", + "type": "map" + }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the beginning IP address in the VLAN IP range", - "length": 255, - "name": "startip", - "required": false, + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", - "length": 255, - "name": "ip6gateway", - "required": false, + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the physical network id", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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, + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "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 omitted", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the gateway of the VLAN IP range", - "length": 255, - "name": "gateway", - "required": false, + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - } - ], - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "response": [ - { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, - {}, - { - "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", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "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 Pod name for the VLAN IP range", - "name": "podname", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" - } - ] - }, - { - "description": "Updates site to site vpn connection", - "isasync": true, - "name": "updateVpnConnection", - "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "id of vpn connection", - "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", - "required": true, - "type": "uuid" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, { - "description": "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": "createVpnConnection,listVpnConnections", - "response": [ - { - "description": "the public IP address", - "name": "publicip", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the connection ID", + "description": "the id of the network", "name": "id", "type": "string" }, - {}, { - "description": "the project id", - "name": "projectid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "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": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "State of vpn connection", - "name": "state", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, {}, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - } - ], - "since": "4.4" + {} + ] }, { - "description": "lists network that are using Palo Alto firewall device", + "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", "isasync": false, - "name": "listPaloAltoFirewallNetworks", + "name": "assignVirtualMachine", "params": [ { - "description": "List by keyword", + "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": "keyword", + "name": "networkids", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "list" + }, + { + "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "length": 255, + "name": "securitygroupids", + "related": "createSecurityGroup", + "required": false, + "type": "list" + }, + { + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "domain id of the new VM owner.", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "palo alto balancer device ID", + "description": "id of the VM to be moved", "length": 255, - "name": "lbdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "", + "description": "an optional project for the new VM owner.", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the type of the network", - "name": "type", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "state of the network", - "name": "state", + "description": "the name of the virtual machine", + "name": "name", "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 state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the list of services", - "name": "service", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the capability value", - "name": "value", + "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": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the service provider name", - "name": "provider", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the service name", - "name": "name", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" } ], - "type": "list" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "type": "set" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the project name of the vm", + "name": "project", "type": "string" }, - {}, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "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 name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, {}, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, + {}, { - "description": "related to what other network configuration", - "name": "related", + "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 routing mode of network offering", - "name": "ip6routing", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the id of the network", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the name of the network", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Synchronize Tungsten-Fabric data", - "isasync": false, - "name": "synchronizeTungstenFabricData", - "params": [ - { - "description": "provider id", - "length": 255, - "name": "id", - "related": "listTungstenFabricProviders", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {} - ] - }, - { - "description": "Get the path associated with the provided volume UUID", - "isasync": false, - "name": "getPathForVolume", - "params": [ { - "description": "CloudStack Volume UUID", - "length": 255, - "name": "volumeid", - "required": true, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "The path field for the volume", - "name": "path", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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": "Lists management servers.", - "isasync": false, - "name": "listManagementServers", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the name of the management server", - "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 id of the management server", - "length": 255, - "name": "id", - "related": "listManagementServers", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" - }, - { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", "type": "date" }, - {}, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the version of the management server", - "name": "version", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the name of the management server", - "name": "name", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 java distribution name running the management server process", - "name": "javadistribution", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "list Tungsten-Fabric policy", + "description": "Lists virtual machines on a unmanaged host", "isasync": false, - "name": "listTungstenFabricPolicyRule", + "name": "listVmsForImport", "params": [ - { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric rule", - "length": 255, - "name": "ruleuuid", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -53258,151 +53832,377 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "the zone ID", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": false, + "required": true, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the username for the host", "length": 255, - "name": "keyword", + "name": "username", "required": false, "type": "string" - } - ], - "related": "addTungstenFabricPolicyRule", - "response": [ + }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" - }, + } + ], + "related": "listVmwareDcVms,listUnmanagedInstances", + "response": [ { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the 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": "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", - "type": "string" + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, - {}, - {}, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", "type": "integer" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" - } - ] + }, + {}, + {} + ], + "since": "4.19.0" }, { - "description": "delete Tungsten-Fabric policy", + "description": " delete a BigSwitch BCF Controller device", "isasync": true, - "name": "deleteTungstenFabricPolicy", + "name": "deleteBigSwitchBcfDevice", "params": [ { - "description": "the ID of zone", + "description": "BigSwitch device ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", "required": true, "type": "uuid" - }, - { - "description": "the Uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "policyuuid", - "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", @@ -53410,11 +54210,6 @@ }, {}, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -53425,41 +54220,94 @@ "name": "displaytext", "type": "string" } - ] + ], + "since": "4.6.0" }, { - "description": "Updates a vm group", - "isasync": false, - "name": "updateInstanceGroup", + "description": "configures a netscaler load balancer device", + "isasync": true, + "name": "configureNetscalerLoadBalancer", "params": [ { - "description": "new instance group name", + "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", "length": 255, - "name": "name", + "name": "lbdevicededicated", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Instance group ID", + "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": "id", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "podids", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "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", + "length": 255, + "name": "inline", + "required": false, + "type": "boolean" + }, + { + "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "length": 255, + "name": "lbdevicecapacity", + "required": false, + "type": "long" + }, + { + "description": "Netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": true, "type": "uuid" } ], - "related": "createInstanceGroup", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, {}, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -53467,206 +54315,179 @@ "type": "integer" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, - {}, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, - { - "description": "the ID of the instance group", - "name": "id", - "type": "string" - } + {} ] }, { - "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", - "isasync": true, - "name": "changeOfferingForVolume", + "description": "Lists all available ovs elements.", + "isasync": false, + "name": "listOvsElements", "params": [ { - "description": "new disk offering id", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "description": "list network offerings by enabled state", "length": 255, - "name": "automigrate", + "name": "enabled", "required": false, "type": "boolean" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "list ovs elements by id", "length": 255, - "name": "miniops", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "List by keyword", "length": 255, - "name": "maxiops", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { - "description": "the ID of the volume", + "description": "", "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": "page", + "required": false, + "type": "integer" }, { - "description": "Verify OK to Shrink", + "description": "", "length": 255, - "name": "shrinkok", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "New volume size in GB for the custom disk offering", + "description": "list ovs elements by network service provider id", "length": 255, - "name": "size", + "name": "nspid", + "related": "listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "long" + "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "configureOvsElement", "response": [ { - "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": "ID of the availability zone", - "name": "zoneid", + "description": "the id of the ovs", + "name": "id", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, {}, + {}, { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the project id of the ipaddress", + "name": "projectid", "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": "the disk utilization", - "name": "utilization", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" - }, + } + ] + }, + { + "description": "delete Tungsten-Fabric service group", + "isasync": true, + "name": "deleteTungstenFabricServiceGroup", + "params": [ { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": true, "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, + } + ], + "response": [ { - "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" }, { @@ -53674,362 +54495,301 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, + } + ] + }, + { + "description": "associate a profile to a blade", + "isasync": true, + "name": "associateUcsProfileToBlade", + "params": [ { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "profile dn", + "length": 255, + "name": "profiledn", + "required": true, "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "ucs manager id", + "length": 255, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, + "description": "blade id", + "length": 255, + "name": "bladeid", + "related": "associateUcsProfileToBlade", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the 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 write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, - {}, { - "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 chain info of the volume", - "name": "chaininfo", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ucs blade id", + "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "Adds a object storage pool", + "isasync": false, + "name": "addObjectStoragePool", + "params": [ { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the name for the object store", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the object store provider name", + "length": 255, + "name": "provider", + "required": true, "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, + } + ], + "related": "", + "response": [ { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the object store", + "name": "name", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the object store currently used size", + "name": "storageused", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the total size of the object store", + "name": "storagetotal", "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "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": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Deletes user from the project", + "isasync": true, + "name": "deleteUserFromProject", + "params": [ { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, + "description": "Id of the user to be removed from the project", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "true if 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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - } + {} ], - "since": "4.17" + "since": "4.15.0" }, { - "description": "List the uploaded certificates for direct download templates", + "description": "Updates a VMware datacenter details for a zone", "isasync": false, - "name": "listTemplateDirectDownloadCertificates", + "name": "updateVmwareDc", "params": [ { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "The username required to connect to resource.", "length": 255, - "name": "listhosts", + "name": "username", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "VMware datacenter name.", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the zone where certificates are uploaded", + "description": "The zone ID", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": false, + "required": true, "type": "uuid" }, { - "description": "list direct download certificate by ID", + "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": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "The password for specified username.", "length": 255, - "name": "keyword", + "name": "password", "required": false, "type": "string" }, { - "description": "", + "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": "page", + "name": "vcenter", "required": false, - "type": "integer" + "type": "string" } ], - "related": "uploadTemplateDirectDownloadCertificate", + "related": "addVmwareDc,listVmwareDcs", "response": [ { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, + {}, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "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" }, { @@ -54037,75 +54797,120 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + } + ], + "since": "4.12.0" + }, + { + "description": "Checks the 2FA code for the user.", + "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 hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, + } + ], + "since": "4.18.0" + }, + { + "description": "Starts a router.", + "isasync": false, + "name": "getRouterHealthCheckResults", + "params": [ { - "description": "the direct download certificate id", - "name": "id", - "type": "string" + "description": "the ID of the router", + "length": 255, + "name": "routerid", + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" }, - {}, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "length": 255, + "name": "performfreshchecks", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the id of the router", + "name": "routerid", "type": "string" }, + {}, { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" - } + "description": "the id of the router", + "name": "healthchecks", + "type": "list" + }, + {} ], - "since": "4.17.0" + "since": "4.14.0" }, { - "description": "List ucs manager", + "description": "list control center", "isasync": false, - "name": "listUcsManagers", + "name": "listNetscalerControlCenter", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the zone id", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -54113,91 +54918,114 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "the ID of the ucs manager", - "length": 255, - "name": "id", - "related": "listUcsManagers,addUcsManager", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], - "related": "addUcsManager", + "related": "", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ncc_ip", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of ucs manager", - "name": "name", + "description": "id", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "uuid", + "name": "uuid", "type": "string" }, { - "description": "the url of ucs manager", - "name": "url", + "description": "num_retries", + "name": "numretries", "type": "string" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "username", + "name": "username", "type": "string" }, - {} + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Upgrades domain router to a new service offering", - "isasync": false, - "name": "changeServiceForRouter", + "description": "Resizes a volume", + "isasync": true, + "name": "resizeVolume", "params": [ { - "description": "the service offering ID to apply to the domain router", + "description": "New maximum number of IOPS", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "maxiops", + "required": false, + "type": "long" + }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "type": "boolean" + }, + { + "description": "New volume size in GB", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": false, "type": "uuid" }, { - "description": "The ID of the router", + "description": "New minimum number of IOPS", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + }, + { + "description": "the ID of the disk volume", "length": 255, "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" } ], - "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { @@ -54206,923 +55034,1237 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "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": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", "name": "hypervisor", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + {}, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, + {}, { - "description": "the template name for the router", - "name": "templatename", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" } ], "type": "set" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the 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": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the ID of 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 router", - "name": "name", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + } + ] + }, + { + "description": "Deletes affinity group", + "isasync": true, + "name": "deleteAffinityGroup", + "params": [ { - "description": "the version of template", - "name": "version", + "description": "the account of the affinity group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the domain ID associated with the router", + "description": "the domain ID of account owning the affinity group", + "length": 255, "name": "domainid", - "type": "string" + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the project of the affinity group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Deletes a network offering.", + "isasync": false, + "name": "deleteNetworkOffering", + "params": [ { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, + "description": "the ID of the network offering", + "length": 255, + "name": "id", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Deletes a Network Service Provider.", + "isasync": true, + "name": "deleteNetworkServiceProvider", + "params": [ + { + "description": "the ID of the network service provider", + "length": 255, + "name": "id", + "related": "listNetworkServiceProviders,listTrafficTypes", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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" + }, + {} + ], + "since": "3.0.0" }, { - "description": "Remove an Ldap Configuration", - "isasync": false, - "name": "deleteLdapConfiguration", + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", "params": [ { - "description": "linked domain", + "description": "the ID of the Pod", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "port", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "port", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Hostname", + "description": "the ID of the containing domain", "length": 255, - "name": "hostname", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "addLdapConfiguration", + "related": "listDedicatedPods", "response": [ + {}, { - "description": "linked domain", + "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 Pod", + "name": "podid", "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": "name of the host running the ldap server", - "name": "hostname", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, - {}, - {} - ], - "since": "4.2.0" + { + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", + "type": "string" + } + ] }, { - "description": "Updates the volume.", - "isasync": true, - "name": "updateVolume", + "description": "List network devices", + "isasync": false, + "name": "listNetworkDevice", "params": [ { - "description": "The state of the volume", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "since": "4.3", - "type": "string" + "type": "integer" }, { - "description": "new name of the volume", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "name", + "name": "networkdevicetype", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the ID of the disk volume", + "description": "parameters for network device", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "networkdeviceparameterlist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "The chain info of the volume", + "description": "List by keyword", "length": 255, - "name": "chaininfo", + "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": "", "length": 255, - "name": "displayvolume", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" + } + ], + "related": "addNetworkDevice", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "The path of the volume", + "description": "the ID of the network device", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", + "isasync": true, + "name": "updateStorageNetworkIpRange", + "params": [ + { + "description": "the beginning IP address", "length": 255, - "name": "path", + "name": "startip", "required": false, "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ending IP address", "length": 255, - "name": "customid", + "name": "endip", "required": false, - "since": "4.4", "type": "string" - } - ], - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ + }, { - "description": "the ID of 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": "UUID of storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, + "description": "Optional. the vlan the ip range sits on", + "length": 255, + "name": "vlan", + "required": false, + "type": "integer" + } + ], + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "response": [ { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "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" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists Project roles in CloudStack", + "isasync": false, + "name": "listProjectRoles", + "params": [ + { + "description": "List project role by project ID.", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "List project role by project role ID.", + "length": 255, + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List project role by project role name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "createProjectRole,updateProjectRole", + "response": [ + { + "description": "the ID of the role", + "name": "id", "type": "string" }, + {}, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the description of the role", + "name": "description", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the id of the project", + "name": "projectid", "type": "string" }, - {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Removes an OpenDyalight controler", + "isasync": true, + "name": "deleteOpenDaylightController", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "OpenDaylight Controller ID", + "length": 255, + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController", + "required": true, + "type": "uuid" + } + ], + "related": "addOpenDaylightController", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the url of the controller api", + "name": "url", + "type": "string" }, + {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the name assigned to the controller", + "name": "name", "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": "the name of the template for the virtual machine", - "name": "templatename", + "description": "device id of the controller", + "name": "id", "type": "string" + } + ] + }, + { + "description": "Updates attributes of a template.", + "isasync": false, + "name": "updateTemplate", + "params": [ + { + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, + { + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "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 ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, - {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "size of the disk volume", - "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -55131,8 +56273,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -55141,8 +56283,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -55151,363 +56293,309 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" - } - ] - }, - { - "description": "Creates a Project role", - "isasync": false, - "name": "createProjectRole", - "params": [ + }, { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": true, + "description": "the project name of the template", + "name": "project", "type": "string" - } - ], - "related": "updateProjectRole", - "response": [ + }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the id of the project", - "name": "projectid", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the 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": "the name of the role", + "description": "the template name", "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the role", - "name": "id", + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ], - "since": "4.15.0" + ] }, { - "description": "Lists traffic types of a given physical network.", + "description": "Creates a VLAN IP range.", "isasync": false, - "name": "listTrafficTypes", + "name": "createVlanIpRange", "params": [ { - "description": "List by keyword", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "keyword", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "page", + "name": "endipv6", "required": false, - "type": "integer" - } - ], - "related": "listNetworkServiceProviders", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, - {}, - {}, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "the network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createIpv6FirewallRule", - "params": [ - { - "description": "the ending port of Ipv6 firewall rule", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "endport", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "fordisplay", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "protocol", - "required": true, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "startport", + "name": "startip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "icmpcode", + "name": "endip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "destcidrlist", + "name": "ip6gateway", "required": false, - "type": "list" + "type": "string" }, { - "description": "The network of the VM the Ipv6 firewall rule will be created for", + "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": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "string" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "traffictype", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "cidrlist", + "name": "forsystemvms", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "the physical network id", "length": 255, - "name": "icmptype", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "response": [ { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, {}, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { @@ -55516,611 +56604,579 @@ "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + {}, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the network id of vlan range", "name": "networkid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" } ] }, { - "description": "Updates account information for the authenticated user", - "isasync": false, - "name": "updateAccount", + "description": "Updates site to site vpn connection", + "isasync": true, + "name": "updateVpnConnection", "params": [ { - "description": "The UUID of the domain where the account exists", + "description": "id of vpn connection", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "required": true, "type": "uuid" }, { - "description": "New name for the account", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "newname", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "networkdomain", + "name": "customid", "required": false, + "since": "4.4", "type": "string" + } + ], + "related": "createVpnConnection,listVpnConnections", + "response": [ + {}, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "Details for the account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "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": "the project name", + "name": "project", + "type": "string" }, { - "description": "Account UUID", - "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, + {}, { - "description": "Current account name", - "length": 255, - "name": "account", - "required": false, + "description": "State of vpn connection", + "name": "state", "type": "string" - } - ], - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "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 total number of templates which can be created by this account", - "name": "templatelimit", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the connection ID", + "name": "id", + "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "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", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ], + "since": "4.4" + }, + { + "description": "lists network that are using Palo Alto firewall device", + "isasync": false, + "name": "listPaloAltoFirewallNetworks", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, - {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "palo alto balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" + } + ], + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the id of the network", + "name": "id", "type": "string" }, - {}, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the domain name of the network owner", + "name": "domain", "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 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": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the date this network 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 network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "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", + "type": "boolean" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, { "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": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account name of the user", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user email address", - "name": "email", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" } ], "type": "list" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ] - }, - { - "description": "Adds secondary storage.", - "isasync": false, - "name": "addSecondaryStorage", - "params": [ - { - "description": "the URL for the secondary storage", - "length": 255, - "name": "url", - "required": true, + "description": "the second IPv4 DNS for the network", + "name": "dns2", "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": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, {}, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { @@ -56129,1722 +57185,1137 @@ "type": "integer" }, { - "description": "the name of the image store", - "name": "name", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "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": "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": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", - "length": 255, - "name": "details", - "required": false, - "type": "map" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", - "required": false, - "type": "list" - }, - { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "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": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", - "length": 255, - "name": "name", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "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": "ACL name associated with the VPC network", + "name": "aclname", "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, + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "the type of the network", + "name": "type", "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 domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "user generated name", - "length": 255, - "name": "displayname", - "required": false, + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.16.0", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "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" - } - ], - "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": "the list of nics associated with vm", - "name": "nic", + "description": "the list of services", + "name": "service", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "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 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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], "type": "list" } ], - "type": "set" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "type": "list" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" - }, + } + ] + }, + { + "description": "Synchronize Tungsten-Fabric data", + "isasync": false, + "name": "synchronizeTungstenFabricData", + "params": [ { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, + "description": "provider id", + "length": 255, + "name": "id", + "related": "listTungstenFabricProviders", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Get the path associated with the provided volume UUID", + "isasync": false, + "name": "getPathForVolume", + "params": [ { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "CloudStack Volume UUID", + "length": 255, + "name": "volumeid", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The path field for the volume", + "name": "path", "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": "Lists management servers.", + "isasync": false, + "name": "listManagementServers", + "params": [ { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the id of the management server", + "length": 255, + "name": "id", + "related": "listManagementServers", + "required": false, + "type": "uuid" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the IP Address for this Management Server", + "name": "serviceip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the management server", + "name": "name", "type": "string" }, + {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of 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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag 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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, + "description": "the ID of the management server", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicyRule", + "params": [ { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the uuid of Tungsten-Fabric rule", + "length": 255, + "name": "ruleuuid", + "required": false, "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, + } + ], + "related": "addTungstenFabricPolicyRule", + "response": [ { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Tungsten-Fabric policy action", + "name": "action", "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": "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" }, + {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "Tungsten-Fabric rule uuid", + "name": "uuid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the 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 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 project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" + } + ] + }, + { + "description": "delete Tungsten-Fabric policy", + "isasync": true, + "name": "deleteTungstenFabricPolicy", + "params": [ { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the Uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + } + ] + }, + { + "description": "Updates a vm group", + "isasync": false, + "name": "updateInstanceGroup", + "params": [ { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "new instance group name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, + "description": "Instance group ID", + "length": 255, + "name": "id", + "related": "createInstanceGroup,updateInstanceGroup", + "required": true, + "type": "uuid" + } + ], + "related": "createInstanceGroup", + "response": [ + {}, + {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the project ID of the instance group", + "name": "projectid", "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the instance group", + "name": "name", "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the instance group", + "name": "id", + "type": "string" } ] }, { - "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced", - "isasync": false, - "name": "triggerShutdown", + "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "isasync": true, + "name": "changeOfferingForVolume", "params": [ { - "description": "the uuid of the management server", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "managementserverid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "prepareForShutdown", - "response": [ - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - }, - { - "description": "The number of jobs in progress", - "name": "pendingjobscount", + "name": "maxiops", + "required": false, "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": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "The id of the management server", - "name": "managementserverid", + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, "type": "long" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" - }, - {}, - {} - ], - "since": "4.19.0" - }, - { - "description": "Disables an account", - "isasync": true, - "name": "disableAccount", - "params": [ - { - "description": "Disables specified account.", + "description": "New volume size in GB for the custom disk offering", "length": 255, - "name": "account", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "Account id", + "description": "the ID of the volume", "length": 255, "name": "id", - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "required": false, + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, "type": "uuid" }, { - "description": "Disables specified account in this domain.", + "description": "Verify OK to Shrink", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "shrinkok", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If true, only lock the account; else disable the account", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "lock", - "required": true, + "name": "automigrate", + "required": false, "type": "boolean" } ], - "related": "createAccount,enableAccount,listAccounts,listAccounts", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "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 total number of cpu cores owned by account", - "name": "cputotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, + {}, { - "description": "the state of the account", - "name": "state", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - } - ], - "type": "list" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "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": "pod name of the volume", + "name": "podname", "type": "string" }, - {}, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date when this account was created", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "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", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, - {}, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" } - ] + ], + "since": "4.17" }, { - "description": "Lists domains and provides detailed information for listed domains", + "description": "List the uploaded certificates for direct download templates", "isasync": false, - "name": "listDomains", + "name": "listTemplateDirectDownloadCertificates", "params": [ { - "description": "List domain by domain ID.", + "description": "", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "the zone where certificates are uploaded", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -57854,33 +58325,12 @@ "type": "string" }, { - "description": "flag to display the resource icon for domains", + "description": "if set to true: include the hosts where the certificate is uploaded to", "length": 255, - "name": "showicon", + "name": "listhosts", "required": false, "type": "boolean" }, - { - "description": "List domains by domain level.", - "length": 255, - "name": "level", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "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": "", "length": 255, @@ -57889,43 +58339,34 @@ "type": "integer" }, { - "description": "List domain by domain name.", + "description": "list direct download certificate by ID", "length": 255, - "name": "name", + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "listDomainChildren,listDomains", + "related": "uploadTemplateDirectDownloadCertificate", "response": [ { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { @@ -57934,1227 +58375,856 @@ "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the state of the domain", - "name": "state", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, + {}, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, + {}, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" - }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, + } + ], + "since": "4.17.0" + }, + { + "description": "List ucs manager", + "isasync": false, + "name": "listUcsManagers", + "params": [ { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the zone id", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the ID of the domain", + "description": "the ID of the ucs manager", + "length": 255, "name": "id", - "type": "string" + "related": "listUcsManagers,addUcsManager", + "required": false, + "type": "uuid" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addUcsManager", + "response": [ + {}, + {}, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, - { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the ID of the ucs manager", + "name": "id", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "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": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "The ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, - {}, - { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, - {}, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "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 domain", - "name": "secondarystorageavailable", - "type": "string" - } - ] - }, - { - "description": "Updates a network", - "isasync": true, - "name": "updateNetwork", - "params": [ - { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "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 display text for the network", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the second DNS for the router", + "name": "dns2", "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": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, - { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the new name for the network", - "length": 255, - "name": "name", - "required": false, + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "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 date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "Force update even if CIDR type is different", - "length": 255, - "name": "changecidr", - "required": false, - "type": "boolean" - }, - { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "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 name of the network", - "name": "name", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "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": "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": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the service name", - "name": "name", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" - } - ], - "type": "list" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - {}, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "the id of the network", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - {}, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ + }, { - "description": "tag key name", - "name": "key", + "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": "customer associated with the tag", - "name": "customer", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" } ], - "type": "list" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "type": "set" }, { - "description": "the network's netmask", - "name": "netmask", - "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 date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the name of the router", + "name": "name", "type": "string" }, + {}, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the account associated with the router", + "name": "account", "type": "string" } ] }, { - "description": "Lists VM backups", + "description": "Remove an Ldap Configuration", "isasync": false, - "name": "listBackups", + "name": "deleteLdapConfiguration", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "port", "length": 255, - "name": "isrecursive", + "name": "port", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "Hostname", "length": 255, - "name": "keyword", - "required": false, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "", + "description": "linked domain", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, + "type": "uuid" + } + ], + "related": "addLdapConfiguration", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "port the ldap server is running on", + "name": "port", + "type": "int" + }, + {}, + {}, + { + "description": "name of the host running the ldap server", + "name": "hostname", + "type": "string" + }, + { + "description": "linked domain", + "name": "domainid", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Updates the volume.", + "isasync": true, + "name": "updateVolume", + "params": [ + { + "description": "an optional field, whether to the display the volume to the end user or not.", "length": 255, - "name": "pagesize", + "name": "displayvolume", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list backups by zone id", + "description": "the ID of the disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "id of the VM", + "description": "new name of the volume", "length": 255, - "name": "virtualmachineid", - "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", + "name": "name", "required": false, - "type": "uuid" + "since": "4.16", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "The chain info of the volume", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "chaininfo", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "id of the backup", + "description": "Destination storage pool UUID for the volume", "length": 255, - "name": "id", - "related": "updateBackupSchedule,listBackups", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The path of the volume", "length": 255, - "name": "account", + "name": "path", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The state of the volume", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "state", "required": false, - "type": "uuid" + "since": "4.3", + "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "listall", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" } ], - "related": "updateBackupSchedule", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ + {}, { - "description": "backup date", - "name": "created", - "type": "string" - }, - { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" - }, - { - "description": "backup type", - "name": "type", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "external backup id", - "name": "externalid", - "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": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "account name", - "name": "account", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "zone id", + "description": "ID of the availability zone", "name": "zoneid", "type": "string" }, { - "description": "domain name", - "name": "domain", - "type": "string" - }, - { - "description": "zone name", - "name": "zone", - "type": "string" - }, - { - "description": "name of the VM", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "domain id", - "name": "domainid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, - {}, - { - "description": "backup status", - "name": "status", - "type": "status" - }, - { - "description": "backup offering id", - "name": "backupofferingid", - "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "List Usage Types", - "isasync": false, - "name": "listUsageTypes", - "params": [], - "related": "", - "response": [ - {}, { - "description": "description of usage type", - "name": "description", - "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": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {}, - { - "description": "usage type", - "name": "usagetypeid", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists Backup and Recovery providers", - "isasync": false, - "name": "listBackupProviders", - "params": [ - { - "description": "List Backup and Recovery provider by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ { - "description": "the description of the CA service provider", - "name": "description", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the CA service provider name", - "name": "name", + "description": "the path of the volume", + "name": "path", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", - "isasync": false, - "name": "resetUserDataForVirtualMachine", - "params": [ - { - "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 userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "type": "map" - }, - { - "description": "The ID of the 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 binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "an optional project for the virtual machine", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -59162,168 +59232,157 @@ "name": "isoid", "type": "string" }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, { "description": "the VM's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "ID of the disk volume", + "name": "id", + "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": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, - {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" } @@ -59331,1058 +59390,468 @@ "type": "set" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + {}, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, + } + ] + }, + { + "description": "Lists traffic types of a given physical network.", + "isasync": false, + "name": "listTrafficTypes", + "params": [ { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "listNetworkServiceProviders", + "response": [ + {}, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "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": "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 name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - {}, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], - "since": "4.18.0" + "since": "3.0.0" }, { - "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteTemplate", + "description": "Creates a Project role", + "isasync": false, + "name": "createProjectRole", "params": [ { - "description": "the ID of the template", + "description": "creates a project role with this unique name", "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the ID of zone of the template", + "description": "ID of project where role is being created", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, "type": "uuid" }, { - "description": "Force delete a template.", + "description": "The description of the Project role", "length": 255, - "name": "forced", + "name": "description", "required": false, - "since": "4.9+", - "type": "boolean" + "type": "string" } ], + "related": "updateProjectRole", "response": [ + {}, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the role", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the role", + "name": "name", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the description of the role", + "name": "description", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" } - ] + ], + "since": "4.15.0" }, { - "description": "Lists all network ACLs", - "isasync": false, - "name": "listNetworkACLLists", + "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createIpv6FirewallRule", "params": [ { - "description": "List by keyword", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "destcidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "isrecursive", + "name": "startport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "fordisplay", + "name": "cidrlist", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "listall", + "name": "endport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Lists network ACL with the specified ID.", + "description": "error code for this ICMP message", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "icmpcode", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list network ACLs by network ID", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list network ACLs by VPC ID", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" }, { - "description": "list network ACLs by specified name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "type of the ICMP message being sent", "length": 255, - "name": "pagesize", + "name": "icmptype", "required": false, "type": "integer" } ], - "related": "createNetworkACLList", + "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "response": [ { - "description": "the Name of the ACL", - "name": "name", - "type": "string" - }, - { - "description": "is ACL for display to the regular user", + "description": "is firewall for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "Description of the ACL", - "name": "description", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + {}, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "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": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + {}, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -60391,28 +59860,28 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "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" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -60421,238 +59890,437 @@ "type": "string" }, { - "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" } ], - "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": "id of the availability zone", - "name": "zoneid", + "description": "Details for the account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, - {}, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The UUID of the domain where the account exists", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "response": [ { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "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", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, + {}, { - "description": "ID of the snapshot", - "name": "id", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "Deletes a VPC", - "isasync": true, - "name": "deleteVPC", - "params": [ + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, { - "description": "the ID of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total 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 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 total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" - } - ] - }, - { - "description": "Updates site to site vpn local gateway", - "isasync": true, - "name": "updateVpnGateway", - "params": [ + }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": true, - "type": "uuid" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "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" - } - ], - "related": "createVpnGateway,listVpnGateways", - "response": [ + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + {}, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, - {}, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, - {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the name of the account", + "name": "name", "type": "string" }, { @@ -60661,404 +60329,587 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" } - ], - "since": "4.4" + ] }, { - "description": "Releases a dedicated guest vlan range to the system", - "isasync": true, - "name": "releaseDedicatedGuestVlanRange", + "description": "Adds secondary storage.", + "isasync": false, + "name": "addSecondaryStorage", "params": [ { - "description": "the ID of the dedicated guest vlan range", + "description": "the Zone ID for the secondary storage", "length": 255, - "name": "id", - "related": "", - "required": true, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" + }, + { + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" } ], + "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {}, + { + "description": "the name of the image store", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "type": "string" } ] }, { - "description": "Deletes security group", + "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": "deleteSecurityGroup", + "name": "updateVirtualMachine", "params": [ { - "description": "The ID of the security group. Mutually exclusive with name parameter", + "description": "user generated name", "length": 255, - "name": "id", - "related": "createSecurityGroup", + "name": "displayname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the project of the security group", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, - "type": "uuid" + "since": "4.12", + "type": "string" }, { - "description": "the domain ID of account owning the security group", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "name", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with id parameter", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "the account of the security group. Must be specified with domain ID", + "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": "account", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "string" - } - ], - "response": [ + "type": "map" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "type": "boolean" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, + "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": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "description": "the ID of the userdata", "length": 255, - "name": "autoselect", + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "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, - "since": "4.16.0", "type": "boolean" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.16.0", + "type": "string" + }, + { + "description": "the ID of the OS type that best represents this VM.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, "type": "uuid" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "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": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "securitygroupnames", + "related": "createSecurityGroup", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the ID of the virtual machine", + "description": "instance name of the user vm", "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": "instancename", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "length": 255, + "name": "haenable", + "required": false, + "type": "boolean" + }, + { + "description": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "createSecurityGroup", + "required": false, + "type": "list" } ], - "related": "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": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the netmask of the nic", + "name": "netmask", "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", - "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": "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" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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": "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 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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + } + ], + "type": "set" + }, + { + "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -61066,9 +60917,9 @@ "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 code for the ICMP message response", @@ -61076,9 +60927,9 @@ "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "the type of the ICMP message response", @@ -61086,10 +60937,15 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the id of the security group rule", "name": "ruleid", @@ -61101,22 +60957,17 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -61125,8 +60976,18 @@ "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", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -61135,8 +60996,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -61145,8 +61011,119 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -61154,145 +61131,302 @@ "name": "projectid", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the security group", + "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the state of the virtual machine", + "name": "state", "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": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "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 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. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { "description": "the project id of the vm", @@ -61300,33 +61434,38 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "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 name of the host for the virtual machine", - "name": "hostname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -61335,126 +61474,124 @@ "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the 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 list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, + {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -61462,13 +61599,8 @@ "name": "affinitygroup", "response": [ { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -61476,11 +61608,6 @@ "name": "domain", "type": "string" }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, { "description": "virtual machine IDs associated with this affinity group", "name": "virtualmachineIds", @@ -61491,14 +61618,19 @@ "name": "name", "type": "string" }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, { "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -61507,284 +61639,481 @@ "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" - }, + } + ] + }, + { + "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced", + "isasync": false, + "name": "triggerShutdown", + "params": [ { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, + "description": "the uuid of the management server", + "length": 255, + "name": "managementserverid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown", + "response": [ { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The id of the management server", + "name": "managementserverid", "type": "long" }, - {}, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Disables an account", + "isasync": true, + "name": "disableAccount", + "params": [ { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "Account id", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Disables specified account.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "Disables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "If true, only lock the account; else disable the account", + "length": 255, + "name": "lock", + "required": true, "type": "boolean" - }, + } + ], + "related": "createAccount,enableAccount,listAccounts,listAccounts", + "response": [ { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + {}, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "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": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the id of the account", + "name": "id", + "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 public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total 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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "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", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the role", + "name": "rolename", "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", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { @@ -61793,95 +62122,81 @@ "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the role", + "name": "rolename", "type": "string" - } - ] - }, - { - "description": "Deletes a Kubernetes cluster", - "isasync": true, - "name": "deleteKubernetesSupportedVersion", - "params": [ - { - "description": "the ID of the Kubernetes supported version", - "length": 255, - "name": "id", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" } ] }, { - "description": "list baremetal rack configuration", + "description": "Lists domains and provides detailed information for listed domains", "isasync": false, - "name": "listBaremetalRct", + "name": "listDomains", "params": [ { "description": "", @@ -61891,217 +62206,135 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "pagesize", + "name": "details", "required": false, - "type": "integer" - } - ], - "related": "addBaremetalRct", - "response": [ - { - "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", - "type": "string" + "type": "list" }, { - "description": "id of rct", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", - "isasync": true, - "name": "createTemplate", - "params": [ - { - "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", + "description": "List domain by domain ID.", "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", + "name": "id", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template.", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": true, - "type": "uuid" - }, - { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "isdynamicallyscalable", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", + "description": "List by keyword", "length": 255, - "name": "ispublic", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "32 or 64 bit", + "description": "List domains by domain level.", "length": 255, - "name": "bits", + "name": "level", "required": false, "type": "integer" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "List domain by domain name.", "length": 255, - "name": "passwordenabled", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "", "length": 255, - "name": "sshkeyenabled", + "name": "pagesize", "required": false, - "type": "boolean" - }, + "type": "integer" + } + ], + "related": "listDomainChildren,listDomains", + "response": [ { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", - "required": false, + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "create template for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" }, { - "description": "true if the template requires HVM, false otherwise", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "the tag of this template", - "name": "templatetag", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "checksum of the template", - "name": "checksum", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, + {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -62109,551 +62342,543 @@ "type": "integer" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "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 project id of the template", - "name": "projectid", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, + {}, { - "description": "the size of the template", - "name": "size", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the state of the domain", + "name": "state", "type": "string" }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - {}, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the template ID", + "description": "the ID of the domain", "name": "id", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" } ] }, { - "description": "Restores an existing stopped or deleted VM using a VM backup", + "description": "Updates a network", "isasync": true, - "name": "restoreBackup", + "name": "updateNetwork", "params": [ { - "description": "ID of the backup", + "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": "id", - "related": "updateBackupSchedule", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "any text associated with the success or failure", + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" + }, + { + "description": "the new display text for the network", + "length": 255, "name": "displaytext", + "required": false, "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "length": 255, + "name": "guestvmcidr", + "required": false, + "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.14.0" - }, - { - "description": "Lists dedicated clusters.", - "isasync": false, - "name": "listDedicatedClusters", - "params": [ { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "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": "", + "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": "pagesize", + "name": "dns2", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", "length": 255, - "name": "page", + "name": "sourcenatipaddress", "required": false, - "type": "integer" + "since": "4.19", + "type": "string" }, { - "description": "the ID of the domain associated with the cluster", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "publicmtu", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "integer" }, { - "description": "the ID of the cluster", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "displaynetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "network domain", "length": 255, - "name": "keyword", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "list dedicated clusters by affinity group", + "description": "network offering ID", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "networkofferingid", + "related": "listNetworkOfferings", "required": false, "type": "uuid" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "Force update even if CIDR type is different", + "length": 255, + "name": "changecidr", + "required": false, + "type": "boolean" + }, + { + "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", + "length": 255, + "name": "updateinsequence", + "required": false, + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the new name for the network", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "length": 255, + "name": "hideipaddressusage", + "required": false, + "type": "boolean" + }, + { + "description": "Setting this to true will cause a forced network update,", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], - "related": "", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, - {}, { - "description": "the name of the cluster", - "name": "clustername", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", - "isasync": true, - "name": "uploadCustomCertificate", - "params": [ + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, { - "description": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "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 ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "message of the certificate upload operation", - "name": "message", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" - } - ] - }, - { - "description": "Lists available certificate authority providers in CloudStack", - "isasync": false, - "name": "listCAProviders", - "params": [ + }, { - "description": "List CA service provider by name", - "length": 255, - "name": "name", - "required": false, + "description": "the domain name of the network owner", + "name": "domain", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the CA service provider name", - "name": "name", + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "the description of the CA service provider", - "name": "description", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" - } - ], - "since": "4.11.0" - }, - { - "description": "Delete site to site vpn customer gateway", - "isasync": true, - "name": "deleteVpnCustomerGateway", - "params": [ + }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { @@ -62661,215 +62886,195 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" - } - ] - }, - { - "description": "Update quota calculations, alerts and statements", - "isasync": false, - "name": "quotaUpdate", - "params": [], - "related": "", - "response": [ + }, { - "description": "timestamp when the run got over", - "name": "updated_on", - "type": "date" + "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": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.7.0" - }, - { - "description": "Lists all port forwarding rules for an IP address.", - "isasync": false, - "name": "listPortForwardingRules", - "params": [ + }, { - "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 network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "Lists rule with the specified ID.", - "length": 255, + "description": "the id of the network", "name": "id", - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "VPC the network belongs to", + "name": "vpcid", "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 network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, + {}, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "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": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "list port forwarding rules for certain network", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - } - ], - "related": "updateIpv6FirewallRule,updatePortForwardingRule", - "response": [ + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the 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 list of resource tags associated with the rule", + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -62878,698 +63083,625 @@ "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, - {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ] - }, - { - "description": "Allocates IP addresses in respective Pod of a Zone", - "isasync": false, - "name": "acquirePodIpAddress", - "params": [ - { - "description": "Pod ID", - "length": 255, - "name": "podid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Gateway for Pod ", - "name": "gateway", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" - }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "CIDR of the Pod", - "name": "cidr", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", - "type": "long" - }, - { - "description": "MAC address of the pod the IP", - "name": "hostmac", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Allocated IP address", - "name": "ipaddress", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" } ] }, { - "description": "Enables out-of-band management for a cluster", - "isasync": true, - "name": "enableOutOfBandManagementForCluster", - "params": [ - { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", + "description": "List Usage Types", + "isasync": false, + "name": "listUsageTypes", + "params": [], + "related": "", "response": [ - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" - }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - {}, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "list Tungsten-Fabric network", - "isasync": false, - "name": "listTungstenFabricNetwork", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, - { - "description": "the uuid of Tungsten-Fabric network", - "length": 255, - "name": "networkuuid", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "usage type", + "name": "usagetypeid", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "Tungsten-Fabric network uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { - "description": "Tungsten-Fabric network name", - "name": "name", + "description": "description of usage type", + "name": "description", "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.", + "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", "isasync": false, - "name": "updateTemplatePermissions", + "name": "resetUserDataForVirtualMachine", "params": [ { - "description": "permission operator (add, remove, reset)", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "op", + "name": "account", "required": false, "type": "string" }, { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", + "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": "boolean" + "type": "string" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "an optional project for the virtual machine", "length": 255, - "name": "isextractable", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "accounts", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "userdatadetails", "required": false, - "type": "list" + "type": "map" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "the ID of the userdata", "length": 255, - "name": "ispublic", + "name": "userdataid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the template ID", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, - {} - ] - }, - { - "description": "List traffic monitor Hosts.", - "isasync": false, - "name": "listTrafficMonitors", - "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "zone Id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" - } - ], - "related": "addTrafficMonitor", - "response": [ + }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" - } - ] - }, - { - "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", - "isasync": true, - "name": "resetPasswordForVirtualMachine", - "params": [ + }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + } + ], + "type": "set" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, { "description": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "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 project name of the vm", - "name": "project", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -63577,111 +63709,49 @@ "name": "readonlydetails", "type": "string" }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the date when this virtual machine was updated last time", "name": "lastupdated", "type": "date" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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 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" }, { - "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", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -63697,58 +63767,28 @@ "name": "icmptype", "type": "integer" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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" }, { @@ -63757,13 +63797,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": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -63772,8 +63812,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], @@ -63783,66 +63828,178 @@ "description": "the protocol of the security group rule", "name": "protocol", "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, + { + "description": "the 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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, { "description": "the project name of the group", "name": "project", "type": "string" }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "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": "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" }, { @@ -63851,41 +64008,21 @@ "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -63894,22 +64031,22 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "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 account owning the security group", - "name": "account", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the domain ID of the security group", @@ -63920,703 +64057,318 @@ "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "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 name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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", + "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 list of nics associated with vm", - "name": "nic", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "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": "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", "name": "instancename", "type": "string" }, + {}, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the 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 date when this virtual machine was created", + "name": "created", + "type": "date" } - ] + ], + "since": "4.18.0" }, { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", "isasync": true, - "name": "updatePortForwardingRule", + "name": "deleteTemplate", "params": [ { - "description": "VM guest nic Secondary ip address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, - "since": "4.5", - "type": "string" - }, - { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "the ID of zone of the template", "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", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the port forwarding rule", + "description": "the ID of the template", "length": 255, "name": "id", - "related": "updateIpv6FirewallRule,updatePortForwardingRule", + "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "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": "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", + "description": "Force delete a template.", "length": 255, - "name": "fordisplay", + "name": "forced", "required": false, - "since": "4.4", + "since": "4.9+", "type": "boolean" - }, - { - "description": "the private end port of the port forwarding rule", - "length": 255, - "name": "privateendport", - "required": false, - "type": "integer" } ], - "related": "updateIpv6FirewallRule", "response": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - {}, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "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 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 ID of the port forwarding rule", - "name": "id", - "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": "Lists Brocade VCS Switches", + "description": "Lists all network ACLs", "isasync": false, - "name": "listBrocadeVcsDevices", + "name": "listNetworkACLLists", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "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": "", @@ -64626,138 +64378,121 @@ "type": "integer" }, { - "description": "Brocade VCS switch ID", + "description": "list network ACLs by VPC ID", "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "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": "device id of the Brocade Vcs", - "name": "vcsdeviceid", - "type": "string" - }, - {}, - { - "description": "device name", - "name": "brocadedevicename", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the principal switch Ip address", - "name": "hostname", - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" - } - ] - }, - { - "description": "link an existing cloudstack domain to group or OU in ldap", - "isasync": false, - "name": "linkDomainToLdap", - "params": [ - { - "description": "name of the group or OU in LDAP", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "type of the ldap name. GROUP or OU", + "description": "Lists network ACL with the specified ID.", "length": 255, - "name": "type", - "required": true, - "type": "string" + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" }, { - "description": "The id of the domain which has to be linked to LDAP.", + "description": "list network ACLs by network ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, { - "description": "domain admin username in LDAP ", + "description": "List by keyword", "length": 255, - "name": "admin", + "name": "keyword", "required": false, "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ldapdomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "list network ACLs by specified name", "length": 255, - "name": "accounttype", - "required": true, - "type": "integer" + "name": "name", + "required": false, + "type": "string" } ], - "related": "linkAccountToLdap", + "related": "createNetworkACLList", "response": [ { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "Description of the ACL", + "name": "description", "type": "string" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -64766,116 +64501,112 @@ {}, {}, { - "description": "type of the name in LDAP which is linke to the domain", - "name": "type", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" - }, - { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" } - ], - "since": "4.6.0" + ] }, { - "description": "Acquires and associates a public IP to an account.", + "description": "Archives (moves) a snapshot on primary storage to secondary storage", "isasync": true, - "name": "associateIpAddress", + "name": "archiveSnapshot", "params": [ { - "description": "The network this IP address should be associated to.", + "description": "The ID of the snapshot", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "id", + "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "required": true, "type": "uuid" + } + ], + "related": "copySnapshot,revertSnapshot,listSnapshots", + "response": [ + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, + {}, { - "description": "the account to associate with this IP address", - "length": 255, + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the account associated with the snapshot", "name": "account", - "required": false, "type": "string" }, { - "description": "the VPC you want the IP address to be associated with", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "the ID of the availability zone you want to acquire an public IP address from", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "Deploy VM for the project", - "length": 255, + "description": "the project id of the snapshot", "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "region ID from where portable IP is to be associated.", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": false, - "type": "integer" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", - "length": 255, - "name": "isportable", - "required": false, - "type": "boolean" + "description": "the 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": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the domain to associate with this IP address", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "IP Address to be associated", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the project name of the snapshot", + "name": "project", "type": "string" - } - ], - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "response": [ + }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "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": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -64884,27 +64615,23 @@ "type": "integer" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, + {}, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with ip address", + "description": "the list of resource tags associated", "name": "tags", "response": [ { @@ -64913,8 +64640,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -64922,24 +64649,19 @@ "name": "resourcetype", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { @@ -64948,278 +64670,226 @@ "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", "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], - "type": "list" - }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "type": "set" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the ID of the zone the public IP address belongs to", + "description": "id of the availability zone", "name": "zoneid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - {}, - { - "description": "public IP address id", + "description": "ID of the snapshot", "name": "id", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "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 domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - }, - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" } ] }, { - "description": "Get the SF Volume Access Group IDs", - "isasync": false, - "name": "getSolidFireVolumeAccessGroupIds", + "description": "Deletes a VPC", + "isasync": true, + "name": "deleteVPC", "params": [ { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, - "type": "string" - }, - { - "description": "Cluster UUID", + "description": "the ID of the VPC", "length": 255, - "name": "clusterid", + "name": "id", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "", "response": [ - {}, - {}, { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "type": "long[]" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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": "Setup the 2FA for the user.", - "isasync": false, - "name": "setupUserTwoFactorAuthentication", + "description": "Updates site to site vpn local gateway", + "isasync": true, + "name": "updateVpnGateway", "params": [ { - "description": "two factor authentication code", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "provider", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "optional: the id of the user for which 2FA has to be disabled", + "description": "id of customer gateway", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "required": true, "type": "uuid" }, { - "description": "Enabled by default, provide false to disable 2FA", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "enable", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" } ], - "related": "", + "related": "createVpnGateway,listVpnGateways", "response": [ { - "description": "the user name", - "name": "username", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, + {}, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, - {}, { - "description": "the user ID", - "name": "id", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, - {}, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "4.18.0" + "since": "4.4" }, { - "description": "Delete site to site vpn connection", + "description": "Releases a dedicated guest vlan range to the system", "isasync": true, - "name": "deleteVpnConnection", + "name": "releaseDedicatedGuestVlanRange", "params": [ { - "description": "id of vpn connection", + "description": "the ID of the dedicated guest vlan range", "length": 255, "name": "id", - "related": "createVpnConnection,listVpnConnections", + "related": "", "required": true, "type": "uuid" } @@ -65230,10 +64900,9 @@ "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" }, { @@ -65241,229 +64910,60 @@ "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": "Creates a ACL rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createNetworkACL", + "description": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", "params": [ { - "description": "error code for this ICMP message", + "description": "The ID of the security group. Mutually exclusive with id parameter", "length": 255, - "name": "icmpcode", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The ID of the security group. Mutually exclusive with name parameter", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "id", + "related": "createSecurityGroup", + "required": false, + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the domain ID of account owning the security group", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "scl entry action, allow or deny", + "description": "the project of the security group", "length": 255, - "name": "action", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "A description indicating why the ACL rule is required.", + "description": "the account of the security group. Must be specified with domain ID", "length": 255, - "name": "reason", + "name": "account", "required": false, "type": "string" - }, - { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" - }, - { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "the starting port of ACL", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "The number of the ACL item, its ordering", - "length": 255, - "name": "number", - "required": false, - "type": "integer" } ], - "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ - { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - {}, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -65471,85 +64971,62 @@ "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - } + }, + {} ] }, { - "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", + "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", "isasync": true, - "name": "resetSSHKeyForVirtualMachine", + "name": "migrateVirtualMachine", "params": [ { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - }, - { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "name of the ssh key pair used to login to the virtual machine", + "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": "keypair", + "name": "autoselect", "required": false, - "type": "string" + "since": "4.16.0", + "type": "boolean" }, { - "description": "an optional project for the ssh key", + "description": "the ID of the virtual machine", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "virtualmachineid", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "keypairs", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "since": "4.17", - "type": "list" + "type": "uuid" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" } ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { "description": "OS name of the vm", @@ -65557,41 +65034,35 @@ "type": "string" }, { - "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", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, - {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { "description": "the write (IO) of disk on the VM", @@ -65599,205 +65070,33 @@ "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "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 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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -65806,123 +65105,30 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the 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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - {}, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, { "description": "the list of resource tags associated", "name": "tags", @@ -65933,23 +65139,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "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": "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" }, { @@ -65958,8 +65159,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -65968,96 +65169,41 @@ "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -66066,98 +65212,23 @@ "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 project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "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": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "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 memory used by the VM in KiB", - "name": "memorykbs", + "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 ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -66165,51 +65236,66 @@ "name": "securitygroup", "response": [ { - "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 project name of the group", - "name": "project", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the 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 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" }, { @@ -66218,8 +65304,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -66228,66 +65314,56 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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 code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { "description": "security group name", "name": "securitygroupname", "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" } ], "type": "set" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the domain name of the security group", "name": "domain", @@ -66298,18 +65374,38 @@ "name": "description", "type": "string" }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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" }, { @@ -66318,8 +65414,13 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -66327,8 +65428,8 @@ "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" }, { @@ -66337,23 +65438,23 @@ "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -66362,75 +65463,45 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", @@ -66441,29 +65512,24 @@ "name": "domainid", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -66472,13 +65538,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], @@ -66488,63 +65554,138 @@ "description": "the project id of the group", "name": "projectid", "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "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 ID of the virtual machine", - "name": "id", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, { "description": "the project name of the vm", "name": "project", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, { "description": "the date when this virtual machine was updated last time", "name": "lastupdated", "type": "date" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -66553,869 +65694,832 @@ "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - } - ] - }, - { - "description": "Lists site to site vpn customer gateways", - "isasync": false, - "name": "listVpnCustomerGateways", - "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, + {}, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "id of the customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "required": false, - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "set" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createVpnCustomerGateway", - "response": [ - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "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", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the project name", - "name": "project", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "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 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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" } ] }, { - "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", + "description": "Deletes a Kubernetes cluster", "isasync": true, - "name": "deleteManagementNetworkIpRange", + "name": "deleteKubernetesSupportedVersion", "params": [ { - "description": "The vlan id the ip range sits on", - "length": 255, - "name": "vlan", - "required": true, - "type": "string" - }, - { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, - "type": "string" - }, - { - "description": "UUID of POD, where the IP range belongs to.", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" - }, - { - "description": "The ending IP address.", - "length": 255, - "name": "endip", - "required": true, - "type": "string" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ], - "since": "4.11.0.0" + { + "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": "Add a supported Kubernetes version", - "isasync": false, - "name": "addKubernetesSupportedVersion", + "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", + "isasync": true, + "name": "createTemplate", "params": [ { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", "length": 255, - "name": "checksum", + "name": "snapshotid", + "related": "copySnapshot,revertSnapshot,listSnapshots", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "description": "true if the template requires HVM, false otherwise", "length": 255, - "name": "semanticversion", - "required": true, - "type": "string" + "name": "requireshvm", + "required": false, + "type": "boolean" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "the tag for this template.", "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" + "name": "templatetag", + "required": false, + "type": "string" }, { - "description": "the name of the Kubernetes supported version", - "length": 255, - "name": "name", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "minmemory", - "required": true, - "type": "integer" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "url", + "name": "isdynamicallyscalable", "required": false, - "type": "string" - } - ], - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "response": [ - { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" - }, - { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "type": "boolean" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" + "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", + "length": 255, + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, - {}, { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", + "description": "32 or 64 bit", + "length": 255, + "name": "bits", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "create template for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the zone for the template. Can be specified with snapshot only", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "uuid" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", + "description": "true if this template is a public template, false otherwise", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" - }, - { - "description": "Name of the Kubernetes supported version", + "description": "the name of the template", + "length": 255, "name": "name", + "required": true, "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" - } - ] - }, - { - "description": "Deletes a Kubernetes cluster", - "isasync": true, - "name": "deleteKubernetesCluster", - "params": [ - { - "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "expunge", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "since": "4.19.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": true, "type": "uuid" - }, - { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.19.0", - "type": "boolean" } ], + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, - {}, { - "description": "any text associated with the success or failure", + "description": "the template display text", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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", "type": "string" }, - {} - ] - }, - { - "description": "Lists and switches to other SAML accounts owned by the SAML user", - "isasync": false, - "name": "listAndSwitchSamlAccount", - "params": [ { - "description": "Domain uuid", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "User uuid", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" - } - ], - "response": [ + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the URL which the template/iso is registered from", + "name": "url", + "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": "true if operation is executed successfully", - "name": "success", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, - {}, - {} - ] - }, - { - "description": "Creates a global load balancer rule", - "isasync": true, - "name": "createGlobalLoadBalancerRule", - "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "domain name for the GSLB service.", - "length": 255, - "name": "gslbdomainname", - "required": true, + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "GSLB service type (tcp, udp, http)", - "length": 255, - "name": "gslbservicetype", - "required": true, + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", - "length": 255, - "name": "gslbstickysessionmethodname", - "required": false, - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the domain ID associated with the load balancer", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "region where the global load balancer is going to be created.", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": true, - "type": "integer" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", - "response": [ - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the load balancer rule ID", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the account of the load balancer rule", + "description": "the account associated with the tag", "name": "account", "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the template ID", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "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": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "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": "Link or unlink a userdata to a template.", - "isasync": false, - "name": "linkUserDataToTemplate", - "params": [ + }, { - "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", - "length": 255, - "name": "userdatapolicy", - "required": false, + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, + {}, { - "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 name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "type": "uuid" + "description": "the project name of the template", + "name": "project", + "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" - } - ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ + "description": "the date this template was created", + "name": "created", + "type": "date" + }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "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", @@ -67423,14 +66527,9 @@ "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "the current status of the latest async job acting on this object", @@ -67438,19 +66537,18 @@ "type": "integer" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, - {}, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -67459,296 +66557,302 @@ "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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 type of the template", + "name": "templatetype", "type": "string" }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, + {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" - }, + } + ] + }, + { + "description": "list baremetal rack configuration", + "isasync": false, + "name": "listBaremetalRct", + "params": [ { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "addBaremetalRct", + "response": [ { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "url", + "name": "url", + "type": "string" }, + {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "id of rct", + "name": "id", + "type": "string" }, + {}, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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": "Lists dedicated clusters.", + "isasync": false, + "name": "listDedicatedClusters", + "params": [ { - "description": "the template name", - "name": "name", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "list dedicated clusters by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain associated with the cluster", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the name of the account associated with the cluster. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "checksum of the template", - "name": "checksum", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" }, {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" - }, + } + ] + }, + { + "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", + "isasync": true, + "name": "uploadCustomCertificate", + "params": [ { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "A name / alias for the certificate.", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", + "required": true, "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "message of the certificate upload operation", + "name": "message", "type": "string" }, + {} + ] + }, + { + "description": "Lists available certificate authority providers in CloudStack", + "isasync": false, + "name": "listCAProviders", + "params": [ { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "List CA service provider by name", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the project id of the template", - "name": "projectid", + "description": "the CA service provider name", + "name": "name", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the 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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the description of the CA service provider", + "name": "description", "type": "string" - } + }, + {}, + {} ], - "since": "4.18.0" + "since": "4.11.0" }, { - "description": " delete a netscaler load balancer device", + "description": "Delete site to site vpn customer gateway", "isasync": true, - "name": "deleteNetscalerLoadBalancer", + "name": "deleteVpnCustomerGateway", "params": [ { - "description": "netscaler load balancer device ID", + "description": "id of customer gateway", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways", "required": true, "type": "uuid" } @@ -67760,6 +66864,7 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -67774,31 +66879,45 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { - "description": "Lists load balancer rules.", + "description": "Lists all port forwarding rules for an IP address.", "isasync": false, - "name": "listGlobalLoadBalancerRules", + "name": "listPortForwardingRules", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the ID of the global load balancer rule", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "type": "uuid" }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -67807,11 +66926,12 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -67821,12 +66941,20 @@ "type": "string" }, { - "description": "region ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -67836,299 +66964,229 @@ "type": "boolean" }, { - "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "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,listProjects,suspendProject,updateProject", + "name": "id", + "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "updateGlobalLoadBalancerRule", + "related": "updateIpv6FirewallRule,updatePortForwardingRule", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, - {}, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", + "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 domain of the load balancer rule", - "name": "domain", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the 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 rule", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "global load balancer rule ID", + "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, + {}, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the name of the load balancer", - "name": "name", - "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 name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account of the load balancer rule", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" - }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" } ] }, { - "description": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", + "description": "Allocates IP addresses in respective Pod of a Zone", + "isasync": false, + "name": "acquirePodIpAddress", "params": [ { - "description": "the ID of the Cluster", + "description": "the ID of the zone", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "Pod ID", + "length": 255, + "name": "podid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "string" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the pod the IP address", + "name": "id", + "type": "long" + }, + { + "description": "Gateway for Pod ", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "nicid", + "type": "long" + }, + { + "description": "the ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -68136,113 +67194,122 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CIDR of the Pod", + "name": "cidr", "type": "string" }, + { + "description": "MAC address of the pod the IP", + "name": "hostmac", + "type": "long" + }, {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Allocated IP address", + "name": "ipaddress", "type": "string" } ] }, { - "description": "Updates a disk offering.", - "isasync": false, - "name": "deleteDiskOffering", + "description": "Enables out-of-band management for a cluster", + "isasync": true, + "name": "enableOutOfBandManagementForCluster", "params": [ { - "description": "ID of the disk offering", + "description": "the ID of the cluster", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "List resource tag(s)", - "isasync": false, - "name": "listTags", - "params": [ + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "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": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the out-of-band management interface username", + "name": "username", "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 out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.9.0" + }, + { + "description": "list Tungsten-Fabric network", + "isasync": false, + "name": "listTungstenFabricNetwork", + "params": [ + { + "description": "the ID of zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -68252,1048 +67319,741 @@ "type": "integer" }, { - "description": "list by resource type", + "description": "", "length": 255, - "name": "resourcetype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by customer name", + "description": "List by keyword", "length": 255, - "name": "customer", + "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 by value", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "value", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "list by key", + "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": "key", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Tungsten-Fabric network name", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric network uuid", + "name": "uuid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "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" } - ], - "since": "4.0.0" + ] }, { - "description": "Get Kubernetes cluster config", + "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": "getKubernetesClusterConfig", + "name": "updateTemplatePermissions", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "name": "projectids", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "list" }, { - "description": "the config data of the cluster", - "name": "configdata", - "type": "string" + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" }, - {}, { - "description": "the id of the container cluster", + "description": "the template ID", + "length": 255, "name": "id", - "type": "string" + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, - {}, { - "description": "Name of the container cluster", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Create a virtual router element.", - "isasync": true, - "name": "createVirtualRouterElement", - "params": [ + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, { - "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "providertype", - "related": "listNetworkServiceProviders", + "name": "op", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the network service provider ID of the virtual router element", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": true, - "type": "uuid" + "name": "isfeatured", + "required": false, + "type": "boolean" } ], - "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ { - "description": "the account associated with the provider", - "name": "account", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { - "description": "Creates a VPC", - "isasync": true, - "name": "createVPC", + "description": "List traffic monitor Hosts.", + "isasync": false, + "name": "listTrafficMonitors", "params": [ { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "create VPC for the project", + "description": "zone Id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the 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 first IPv6 DNS for the VPC", + "description": "", "length": 255, - "name": "ip6dns1", + "name": "page", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "the first IPv4 DNS for the VPC", + "description": "", "length": 255, - "name": "dns1", + "name": "pagesize", "required": false, - "since": "4.18.0", - "type": "string" - }, + "type": "integer" + } + ], + "related": "addTrafficMonitor", + "response": [ + {}, { - "description": "the name of the VPC", - "length": 255, - "name": "name", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, + {}, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + } + ] + }, + { + "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", + "isasync": true, + "name": "resetPasswordForVirtualMachine", + "params": [ { - "description": "the ID of the VPC offering", + "description": "The ID of the virtual machine", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", - "length": 255, - "name": "start", - "required": false, - "since": "4.3", - "type": "boolean" - }, - { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": true, - "type": "string" - }, - { - "description": "the second IPv4 DNS for the VPC", + "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "dns2", + "name": "password", "required": false, - "since": "4.18.0", + "since": "4.19.0", "type": "string" } ], - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - {}, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the owner of the VPC", - "name": "account", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the id of the VPC", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the VPC", - "name": "name", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with the project", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" - } - ], - "type": "list" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of supported services", - "name": "service", - "response": [ + }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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": "state of the network provider", - "name": "state", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "uuid of the network provider", - "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the provider name", - "name": "name", + "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" } ], - "type": "list" + "type": "set" }, { - "description": "the list of capabilities", - "name": "capability", + "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 capability name", - "name": "name", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project 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 value", + "name": "value", + "type": "string" + } + ], + "type": "set" } ], - "type": "list" + "type": "set" }, { - "description": "the service name", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the security group", "name": "name", "type": "string" } ], - "type": "list" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - } - ] - }, - { - "description": "Deletes a autoscale policy.", - "isasync": true, - "name": "deleteAutoScalePolicy", - "params": [ - { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" - } - ] - }, - { - "description": "Deletes a role", - "isasync": false, - "name": "deleteRole", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.9.0" - }, - { - "description": "List internal LB VMs.", - "isasync": false, - "name": "listInternalLoadBalancerVMs", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID of the Internal LB VM", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Internal LB VM", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "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": "the Zone ID of the Internal LB VM", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "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": "the state of the Internal LB VM", - "length": 255, - "name": "state", - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the host ID of the Internal LB VM", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the Internal LB VM", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List Internal LB VMs by VPC", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "destroyRouter,listRouters", - "response": [ - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "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 project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "detailed response generated on running health check", - "name": "details", + "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": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -69302,23 +68062,33 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -69327,23 +68097,23 @@ "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -69352,1289 +68122,2008 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, + {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "Removes detail for the Resource.", - "isasync": true, - "name": "removeResourceDetail", - "params": [ + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { - "description": "Delete details for resource id", - "length": 255, - "name": "resourceid", - "required": true, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Delete details matching key/value pairs", - "length": 255, - "name": "key", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Delete detail by resource type", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {} - ] - }, - { - "description": "Lists all supported OS types for this cloud.", - "isasync": false, - "name": "listOsTypes", - "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "list by Os type Id", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "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 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 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 ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "list by Os Category id", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, - "type": "uuid" - }, - { - "description": "list os by description", - "length": 255, - "name": "description", - "required": false, - "since": "3.0.1", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "addGuestOs", - "response": [ - { - "description": "the ID of the OS type", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the OS type", - "name": "name", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, + {}, { - "description": "is the guest OS user defined", - "name": "isuserdefined", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {} - ] - }, - { - "description": "Deletes a particular egress rule from this security group", - "isasync": true, - "name": "revokeSecurityGroupEgress", - "params": [ { - "description": "The ID of the egress rule", - "length": 255, - "name": "id", - "related": "authorizeSecurityGroupIngress", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, - {}, { - "description": "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", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "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": "addGuestOs", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ], - "since": "4.4.0" + ] }, { - "description": "Uploads an icon for the specified resource(s)", - "isasync": false, - "name": "uploadResourceIcon", + "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "isasync": true, + "name": "updatePortForwardingRule", "params": [ { - "description": "list of resources to upload the icon/image for", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "type of the resource", + "description": "the ID of the port forwarding rule", "length": 255, - "name": "resourcetype", + "name": "id", + "related": "updateIpv6FirewallRule,updatePortForwardingRule", "required": true, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the private start port of the port forwarding rule", + "length": 255, + "name": "privateport", + "required": false, "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", + "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": "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": "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" }, - {} - ], - "since": "4.16.0.0" - }, - { - "description": "Update a supported Kubernetes version", - "isasync": false, - "name": "updateKubernetesSupportedVersion", - "params": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", + "description": "VM guest nic Secondary ip address for the port forwarding rule", "length": 255, - "name": "state", - "required": true, + "name": "vmguestip", + "required": false, + "since": "4.5", "type": "string" }, { - "description": "the ID of the Kubernetes supported version", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" + "name": "privateendport", + "required": false, + "type": "integer" } ], - "related": "listKubernetesSupportedVersions", + "related": "updateIpv6FirewallRule", "response": [ + {}, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, - {}, - {}, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "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", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, + {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, { - "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", - "isasync": true, - "name": "detachIso", + "description": "Lists Brocade VCS Switches", + "isasync": false, + "name": "listBrocadeVcsDevices", "params": [ { - "description": "The ID of the virtual machine", + "description": "Brocade VCS switch ID", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", + "required": false, "type": "uuid" }, { - "description": "If true, ejects the ISO before detaching on VMware. Default: false", + "description": "", "length": 255, - "name": "forced", + "name": "page", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "", "response": [ { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "name of the provider", + "name": "provider", "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": "ssh key-pairs", - "name": "keypairs", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "device name", + "name": "brocadedevicename", + "type": "string" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + } + ] + }, + { + "description": "link an existing cloudstack domain to group or OU in ldap", + "isasync": false, + "name": "linkDomainToLdap", + "params": [ + { + "description": "The id of the domain which has to be linked to LDAP.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", + "required": false, "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "type of the ldap name. GROUP or OU", + "length": 255, + "name": "type", + "required": true, "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": true, + "type": "integer" + }, + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": false, "type": "string" + } + ], + "related": "linkAccountToLdap", + "response": [ + { + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", + "type": "string" }, - {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Domain Admin accountId that is created", + "name": "accountid", + "type": "string" }, { - "description": "the project id of the vm", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.6.0" + }, + { + "description": "Acquires and associates a public IP to an account.", + "isasync": true, + "name": "associateIpAddress", + "params": [ + { + "description": "the ID of the domain to associate with this IP address", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Deploy VM for the project", + "length": 255, "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the availability zone you want to acquire an public IP address from", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the account to associate with this IP address", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "length": 255, + "name": "isportable", + "required": false, + "type": "boolean" + }, + { + "description": "the VPC you want the IP address to be associated with", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "The network this IP address should be associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "IP Address to be associated", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "region ID from where portable IP is to be associated.", + "length": 255, + "name": "regionid", + "related": "addRegion,listRegions", + "required": false, + "type": "integer" + }, + { + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "public IP address", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "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", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", + "description": "the ID of the zone the public IP address belongs to", "name": "zoneid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" - }, + } + ] + }, + { + "description": "Get the SF Volume Access Group IDs", + "isasync": false, + "name": "getSolidFireVolumeAccessGroupIds", + "params": [ { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Cluster UUID", + "length": 255, + "name": "clusterid", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the 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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" }, + {}, + {} + ] + }, + { + "description": "Setup the 2FA for the user.", + "isasync": false, + "name": "setupUserTwoFactorAuthentication", + "params": [ { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "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 group ID of the virtual machine", - "name": "groupid", + "description": "two factor authentication code", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "Enabled by default, provide false to disable 2FA", + "length": 255, + "name": "enable", + "required": false, "type": "boolean" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "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", + "isasync": true, + "name": "deleteVpnConnection", + "params": [ { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "createVpnConnection,listVpnConnections", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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 service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createNetworkACL", + "params": [ + { + "description": "the ending port of ACL", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "The network of the VM the ACL will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "A description indicating why the ACL rule is required.", + "length": 255, + "name": "reason", + "required": false, "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "The network of the VM the ACL will be created for", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" + }, + { + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "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": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "The number of the ACL item, its ordering", + "length": 255, + "name": "number", + "required": false, + "type": "integer" + } + ], + "related": "updateNetworkACLItem,moveNetworkAclItem", + "response": [ + { + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + {}, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + {} + ] + }, + { + "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", + "isasync": true, + "name": "resetSSHKeyForVirtualMachine", + "params": [ + { + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" + }, + { + "description": "names of the ssh key pairs to be used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" + }, + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the 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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "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": "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the 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" }, { @@ -70643,14 +70132,19 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "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 list of resource tags associated with the rule", @@ -70662,18 +70156,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -70682,37 +70176,42 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the id of the security group rule", @@ -70720,26 +70219,16 @@ "type": "string" }, { - "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 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" }, { @@ -70748,18 +70237,13 @@ "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -70767,13 +70251,13 @@ "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": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -70782,23 +70266,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -70807,50 +70291,65 @@ "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 project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the 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", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -70858,18 +70357,8 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -70878,8 +70367,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -70888,8 +70377,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -70898,32 +70387,32 @@ "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" @@ -70934,12 +70423,69 @@ "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the project id of the group", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" } @@ -70948,847 +70494,643 @@ }, {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", + "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - } - ] - }, - { - "description": "Creates a guest network IPv6 prefix.", - "isasync": true, - "name": "createGuestNetworkIpv6Prefix", - "params": [ - { - "description": "UUID of zone to which the IPv6 prefix belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "The /56 or higher IPv6 CIDR for network prefix.", - "length": 255, - "name": "prefix", - "required": true, - "type": "string" - } - ], - "related": "listGuestNetworkIpv6Prefixes", - "response": [ - { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" - }, - {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" - }, - { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" - }, - { - "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", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" - }, - { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" - } - ], - "since": "4.17.0.0" - }, - { - "description": " delete a Palo Alto firewall device", - "isasync": true, - "name": "deletePaloAltoFirewall", - "params": [ - { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if 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, + "description": "the ID of the virtual machine", "name": "id", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists Tungsten-Fabric providers", - "isasync": false, - "name": "listTungstenFabricProviders", - "params": [ - { - "description": "", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - {}, - { - "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Tungsten-Fabric provider zone name", + "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, - {}, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", - "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": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists all DeploymentPlanners available.", - "isasync": false, - "name": "listDeploymentPlanners", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Deployment Planner name", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" } ] }, { - "description": "Deletes a cluster.", + "description": "Lists site to site vpn customer gateways", "isasync": false, - "name": "deleteCluster", + "name": "listVpnCustomerGateways", "params": [ { - "description": "the cluster ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, + "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Prepares a host for maintenance.", - "isasync": true, - "name": "prepareHostForMaintenance", - "params": [ - { - "description": "the host ID", + "description": "id of the customer gateway", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, + "related": "createVpnCustomerGateway,listVpnCustomerGateways", + "required": false, "type": "uuid" - } - ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "response": [ - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "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 amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "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 removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, + } + ], + "related": "createVpnCustomerGateway", + "response": [ { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, + {}, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "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 CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, - {}, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, {}, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the host version", - "name": "version", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "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": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the project name", + "name": "project", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", + "isasync": true, + "name": "deleteManagementNetworkIpRange", + "params": [ { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The vlan id the ip range sits on", + "length": 255, + "name": "vlan", + "required": true, "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": "The starting IP address.", + "length": 255, + "name": "startip", + "required": true, "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "The ending IP address.", + "length": 255, + "name": "endip", + "required": true, "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the 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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ] + ], + "since": "4.11.0.0" }, { - "description": "Creates a role", + "description": "Add a supported Kubernetes version", "isasync": false, - "name": "createRole", + "name": "addKubernetesSupportedVersion", "params": [ { - "description": "The description of the role", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", "length": 255, - "name": "ispublic", + "name": "directdownload", "required": false, + "since": "4.18.2", "type": "boolean" }, { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "url", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Creates a role with this unique name", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "name", + "name": "semanticversion", "required": true, "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "type", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "length": 255, + "name": "minmemory", + "required": true, + "type": "integer" + }, + { + "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", "required": false, "type": "string" + }, + { + "description": "the minimum number of CPUs to be set with the Kubernetes version", + "length": 255, + "name": "mincpunumber", + "required": true, + "type": "integer" } ], - "related": "importRole,listRoles,updateRole", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "the type of the role", - "name": "type", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the name of the role", - "name": "name", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the ID of the role", - "name": "id", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { @@ -71797,87 +71139,109 @@ "type": "string" }, { - "description": "the description of the role", - "name": "description", - "type": "string" - }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, - {}, - {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.9.0" - }, - { - "description": "Removes specified region", - "isasync": false, - "name": "removeRegion", - "params": [ + }, { - "description": "ID of the region to delete", - "length": 255, - "name": "id", - "required": true, + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + { + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" + }, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" }, - {} + { + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" + }, + {}, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" + } ] }, { - "description": "Get Volume's iSCSI Name", - "isasync": false, - "name": "getVolumeiScsiName", + "description": "Deletes a Kubernetes cluster", + "isasync": true, + "name": "deleteKubernetesCluster", "params": [ { - "description": "CloudStack Volume UUID", + "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", "length": 255, - "name": "volumeid", + "name": "expunge", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.19.0", + "type": "boolean" } ], - "related": "", "response": [ { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", - "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", @@ -71885,6 +71249,11 @@ "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", @@ -71894,104 +71263,102 @@ ] }, { - "description": "Upload a data disk to the cloudstack cloud.", - "isasync": false, - "name": "getUploadParamsForVolume", + "description": "Creates a global load balancer rule", + "isasync": true, + "name": "createGlobalLoadBalancerRule", "params": [ { - "description": "Upload volume/template for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "checksum", + "name": "account", "required": false, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "name of the load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "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.", + "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": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "gslblbmethod", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the volume/template", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "name", - "required": true, + "name": "gslbstickysessionmethodname", + "required": false, "type": "string" }, { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", + "description": "region where the global load balancer is going to be created.", "length": 255, - "name": "format", + "name": "regionid", + "related": "addRegion,listRegions", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Image store uuid", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "imagestoreuuid", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the zone the volume/template is to be hosted on", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "gslbservicetype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "domain name for the GSLB service.", "length": 255, - "name": "account", - "required": false, + "name": "gslbdomainname", + "required": true, "type": "string" } ], - "related": "getUploadParamsForTemplate,getUploadParamsForIso", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the project name of the load balancer", + "name": "project", + "type": "string" }, { - "description": "the template/volume ID", + "description": "global load balancer rule ID", "name": "id", - "type": "uuid" + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, + {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { @@ -72000,600 +71367,1025 @@ "type": "integer" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, - {} - ], - "since": "4.6.0" - }, - { - "description": "Updates an existing autoscale vm group.", - "isasync": true, - "name": "updateAutoScaleVmGroup", - "params": [ - { - "description": "list of scaledown autoscale policies", - "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" - }, { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the frequency in which the performance counters to be collected", - "length": 255, - "name": "interval", - "required": false, - "type": "integer" + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" }, { - "description": "an optional field, whether to the display the group to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "length": 255, - "name": "maxmembers", - "required": false, - "type": "integer" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "length": 255, - "name": "minmembers", - "required": false, - "type": "integer" + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" }, { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" - } - ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", + "response": [ + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" }, + {} + ] + }, + { + "description": "Link or unlink a userdata to a template.", + "isasync": false, + "name": "linkUserDataToTemplate", + "params": [ { - "description": "the autoscale vm group ID", - "name": "id", + "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "length": 255, + "name": "userdatapolicy", + "required": false, "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the ID of the ISO for the virtual machine", + "length": 255, + "name": "isoid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" - }, + "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "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", + "description": "the processor bit size", + "name": "bits", "type": "int" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the template name", + "name": "name", "type": "string" }, { - "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 current state of the AutoScale Vm Group", - "name": "state", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, - {}, - {} - ] - }, - { - "description": "Updates an existing autoscale vm profile.", - "isasync": true, - "name": "updateAutoScaleVmProfile", - "params": [ { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.18.0", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "length": 255, - "name": "expungevmgraceperiod", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the autoscale vm profile", - "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "length": 255, - "name": "autoscaleuserid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" + "description": "the project name of the template", + "name": "project", + "type": "string" }, + {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", - "length": 255, - "name": "otherdeployparams", - "required": false, - "since": "4.18.0", - "type": "map" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "an optional field, whether to the display the profile to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, + {}, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", - "length": 255, - "name": "counterparam", - "required": false, - "type": "map" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.18.0", - "type": "uuid" - } - ], - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", - "response": [ - { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the vm profile", + "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "Base 64 encoded VM user data", - "name": "userdata", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, - {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "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 service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", + "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "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 domain ID of the vm profile", - "name": "domainid", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "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", "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" } - ] + ], + "since": "4.18.0" }, { - "description": "Enables an AutoScale Vm Group", + "description": " delete a netscaler load balancer device", "isasync": true, - "name": "enableAutoScaleVmGroup", + "name": "deleteNetscalerLoadBalancer", "params": [ { - "description": "the ID of the autoscale group", + "description": "netscaler load balancer device ID", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": true, "type": "uuid" } ], - "related": "listAutoScaleVmGroups", "response": [ { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "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 domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Lists load balancer rules.", + "isasync": false, + "name": "listGlobalLoadBalancerRules", + "params": [ { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": false, + "type": "uuid" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the project id of the vm group", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, "name": "projectid", - "type": "string" + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, - {}, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "region ID", + "length": 255, + "name": "regionid", + "related": "addRegion,listRegions", + "required": false, + "type": "integer" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "updateGlobalLoadBalancerRule", + "response": [ + {}, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the name of the autoscale vm group ", + "description": "name of the global load balancer rule", "name": "name", "type": "string" }, { - "description": "the account owning the vm group", + "description": "the account of the load balancer rule", "name": "account", "type": "string" }, + {}, { - "description": "the public port", - "name": "publicport", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", + "response": [ + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + } + ], + "type": "list" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the description of the global load balancer rule", + "name": "description", + "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": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "global load balancer rule ID", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" } ] }, { - "description": "Deletes a snapshot of a disk volume.", + "description": "Release the dedication for cluster", "isasync": true, - "name": "deleteSnapshot", + "name": "releaseDedicatedCluster", "params": [ { - "description": "The ID of the snapshot", + "description": "the ID of the Cluster", "length": 255, - "name": "id", - "related": "revertSnapshot", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], "response": [ - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {} + ] + }, + { + "description": "Updates a disk offering.", + "isasync": false, + "name": "deleteDiskOffering", + "params": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -72602,306 +72394,394 @@ ] }, { - "description": "Lists guest network IPv6 prefixes", + "description": "List resource tag(s)", "isasync": false, - "name": "listGuestNetworkIpv6Prefixes", + "name": "listTags", "params": [ { - "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": "", + "description": "list by key", "length": 255, - "name": "page", + "name": "key", "required": false, - "type": "integer" + "type": "string" }, { - "description": "UUID of the IPv6 prefix.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list by customer name", "length": 255, - "name": "pagesize", + "name": "customer", "required": false, - "type": "integer" + "type": "string" }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list by resource type", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "list by value", + "length": 255, + "name": "value", + "required": false, "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "list by resource id", + "length": 255, + "name": "resourceid", + "required": false, + "type": "string" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "tag key name", + "name": "key", + "type": "string" }, - {}, - {}, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, + {}, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the ID of the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" } ], - "since": "4.17.0" + "since": "4.0.0" }, { - "description": "List the virtual machines owned by the account.", + "description": "Get Kubernetes cluster config", "isasync": false, - "name": "listVirtualMachines", + "name": "getKubernetesClusterConfig", "params": [ { - "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 ID of the Kubernetes cluster", "length": 255, - "name": "state", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the id of the container cluster", + "name": "id", "type": "string" }, { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the config data of the cluster", + "name": "configdata", + "type": "string" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "type": "uuid" - }, + "description": "Name of the container cluster", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Create a virtual router element.", + "isasync": true, + "name": "createVirtualRouterElement", + "params": [ { - "description": "list vms by iso", + "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", "length": 255, - "name": "isoid", + "name": "providertype", + "related": "listNetworkServiceProviders", "required": false, "type": "uuid" }, { - "description": "list vms by vpc", + "description": "the network service provider ID of the virtual router element", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "nspid", + "related": "listNetworkServiceProviders", + "required": true, "type": "uuid" - }, + } + ], + "related": "configureVirtualRouterElement,listVirtualRouterElements", + "response": [ { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "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, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", - "length": 255, - "name": "haenable", - "required": false, - "since": "4.15", - "type": "boolean" + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "since": "4.16.0", - "type": "uuid" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", - "length": 255, - "name": "userdata", - "required": false, - "since": "4.18.0.0", - "type": "boolean" + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" }, + {}, { - "description": "the IDs of the virtual machines, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "since": "4.4", - "type": "list" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the account associated with the provider", + "name": "account", + "type": "string" }, + {}, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", - "length": 255, - "name": "name", - "required": false, + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.0", + "description": "Enabled/Disabled the service provider", + "name": "enabled", "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", + "description": "the id of the router", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Creates a VPC", + "isasync": true, + "name": "createVPC", + "params": [ + { + "description": "the ID of the availability zone", "length": 255, - "name": "details", - "required": false, - "type": "list" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the first IPv4 DNS for the VPC", "length": 255, - "name": "listall", + "name": "dns1", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", "length": 255, - "name": "id", - "related": "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": "sourcenatipaddress", "required": false, - "type": "uuid" + "since": "4.19", + "type": "string" }, { - "description": "list vms by affinity group", + "description": "the first IPv6 DNS for the VPC", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "ip6dns1", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "displayvm", + "name": "fordisplay", "required": false, "since": "4.4", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "account", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "list vms by ssh keypair name", + "description": "the second IPv6 DNS for the VPC", "length": 255, - "name": "keypair", + "name": "ip6dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the host ID", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", "required": false, + "since": "4.18.0", + "type": "integer" + }, + { + "description": "the ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": true, "type": "uuid" }, { - "description": "the group ID", + "description": "create VPC for the project", "length": 255, - "name": "groupid", - "related": "createInstanceGroup", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "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", @@ -72909,1015 +72789,810 @@ "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "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": "retrieveonlyresourcecount", + "name": "start", "required": false, + "since": "4.3", "type": "boolean" }, { - "description": "the ID of AutoScaling VM Group", + "description": "the second IPv4 DNS for the VPC", "length": 255, - "name": "autoscalevmgroupid", - "related": "listAutoScaleVmGroups", + "name": "dns2", "required": false, "since": "4.18.0", - "type": "uuid" + "type": "string" }, { - "description": "the security group ID", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" + "name": "cidr", + "required": true, + "type": "string" }, { - "description": "list by network id", + "description": "the name of the VPC", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" }, { - "description": "list vms by template", - "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "related": "listBackupProviderOfferings,importBackupOffering", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" }, { - "description": "list by the service offering", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "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 list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ + }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, + {}, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the VPC", + "name": "name", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Deletes a autoscale policy.", + "isasync": true, + "name": "deleteAutoScalePolicy", + "params": [ + { + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ] + }, + { + "description": "Deletes a role", + "isasync": false, + "name": "deleteRole", + "params": [ + { + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the 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 high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, + } + ], + "since": "4.9.0" + }, + { + "description": " delete a Cisco Nexus VSM device", + "isasync": true, + "name": "deleteCiscoNexusVSM", + "params": [ { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", + "length": 255, + "name": "id", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "List internal LB VMs.", + "isasync": false, + "name": "listInternalLoadBalancerVMs", + "params": [ { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "List Internal LB VMs by VPC", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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 account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the Internal LB VM", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the state of the Internal LB VM", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the ID of the Internal LB VM", + "length": 255, + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the Pod ID of the Internal LB VM", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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 resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the Zone ID of the Internal LB VM", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters", + "response": [ + { + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, - {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the 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 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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 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": "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the version of template", + "name": "version", "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": "OS name of the vm", - "name": "osdisplayname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the name of the affinity group", - "name": "name", - "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "type": "list" }, - {}, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "tag value", - "name": "value", - "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" - } - ], - "type": "set" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "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": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the corresponding network", + "name": "networkname", "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": "the ID of the nic", - "name": "id", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { @@ -73926,240 +73601,264 @@ "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 ID of the corresponding network", - "name": "networkid", + "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "type": "set" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - } - ] - }, - { - "description": "Updates the information about Guest OS to Hypervisor specific name mapping", - "isasync": true, - "name": "updateGuestOsMapping", - "params": [ + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", - "length": 255, - "name": "osmappingcheckenabled", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "Hypervisor specific name for this Guest OS", - "length": 255, - "name": "osnameforhypervisor", - "required": true, + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "UUID of the Guest OS to hypervisor name Mapping", - "length": 255, - "name": "id", - "related": "updateGuestOsMapping", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "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 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 the mapping user defined", - "name": "isuserdefined", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, - {}, - {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "delete Tungsten-Fabric tag", - "isasync": true, - "name": "deleteTungstenFabricTag", - "params": [ + }, { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of zone", - "length": 255, + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the Zone ID for the router", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the public netmask for the router", + "name": "publicnetmask", + "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 gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, {} ] }, { - "description": "Lists all available disk offerings.", + "description": "Lists Cisco VNMC controllers", "isasync": false, - "name": "listDiskOfferings", + "name": "listCiscoVnmcResources", "params": [ { - "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": "ID of the disk offering", + "description": "Cisco VNMC resource ID", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "resourceid", + "related": "listCiscoVnmcResources", "required": false, "type": "uuid" }, @@ -74171,313 +73870,378 @@ "type": "integer" }, { - "description": "listed offerings support disk encryption", + "description": "List by keyword", "length": 255, - "name": "encrypt", + "name": "keyword", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, + {}, + {}, { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Removes detail for the Resource.", + "isasync": true, + "name": "removeResourceDetail", + "params": [ { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "description": "Delete details for resource id", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.17", - "type": "uuid" + "name": "resourceid", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "Delete details matching key/value pairs", "length": 255, - "name": "keyword", + "name": "key", "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": "Delete detail by resource type", "length": 255, - "name": "listall", - "required": false, + "name": "resourcetype", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "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 ID of the volume, tags of the volume are used to filter the offerings", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + {} + ] + }, + { + "description": "Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.", + "isasync": true, + "name": "executeClusterDrsPlan", + "params": [ { - "description": "id of zone disk offering is associated with", + "description": "ID of cluster", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", + "name": "id", + "related": "addCluster,updateCluster", + "required": true, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", "length": 255, - "name": "isrecursive", + "name": "migrateto", "required": false, - "type": "boolean" + "type": "map" } ], - "related": "createDiskOffering", + "related": "", "response": [ + {}, + {}, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "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" - }, - { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, + {}, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists all supported OS types for this cloud.", + "isasync": false, + "name": "listOsTypes", + "params": [ { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "list by Os type Id", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "list os by description", + "length": 255, + "name": "description", + "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "list by Os Category id", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "type": "uuid" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "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.18.1", + "type": "boolean" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" + } + ], + "related": "addGuestOs", + "response": [ + { + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the name of the OS type", + "name": "name", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "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": "the name of the OS category", + "name": "oscategoryname", + "type": "string" }, {}, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" }, + {}, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + } + ] + }, + { + "description": "Deletes a particular egress rule from this security group", + "isasync": true, + "name": "revokeSecurityGroupEgress", + "params": [ { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, + "description": "The ID of the egress rule", + "length": 255, + "name": "id", + "related": "authorizeSecurityGroupIngress", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "an alternate display text of the disk offering.", + "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Removes a Guest OS from listing.", + "isasync": true, + "name": "removeGuestOs", + "params": [ { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, + "description": "ID of the guest OS", + "length": 255, + "name": "id", + "related": "addGuestOs", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the 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": "Update password of a host/pool on management server.", + "description": "Uploads an icon for the specified resource(s)", "isasync": false, - "name": "updateHostPassword", + "name": "uploadResourceIcon", "params": [ { - "description": "if the password should also be updated on the hosts", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "update_passwd_on_host", - "required": false, - "type": "boolean" + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the username for the host/cluster", - "length": 255, - "name": "username", + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", "required": true, "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "the new password for the host/cluster", + "description": "type of the resource", "length": 255, - "name": "password", + "name": "resourcetype", "required": true, "type": "string" - }, - { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" } ], "response": [ @@ -74486,437 +74250,726 @@ "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} - ] + ], + "since": "4.16.0.0" }, { - "description": "adds a range of portable public IP's to a region", - "isasync": true, - "name": "createPortableIpRange", + "description": "Update a supported Kubernetes version", + "isasync": false, + "name": "updateKubernetesSupportedVersion", "params": [ { - "description": "the gateway for the portable IP range", + "description": "the enabled or disabled state of the Kubernetes supported version", "length": 255, - "name": "gateway", + "name": "state", "required": true, "type": "string" }, { - "description": "Id of the Region", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "id", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, + "type": "uuid" + } + ], + "related": "listKubernetesSupportedVersions", + "response": [ + { + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", "type": "integer" }, { - "description": "VLAN id, if not specified defaulted to untagged", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the ending IP address in the portable IP range", - "length": 255, - "name": "endip", - "required": true, + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the beginning IP address in the portable IP range", - "length": 255, - "name": "startip", - "required": true, + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the netmask of the portable IP range", - "length": 255, - "name": "netmask", - "required": true, + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, - {}, { - "description": "portable IP range ID", + "description": "the id of the Kubernetes supported version", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + { + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, - {}, { "description": "the 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", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" + }, + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", + "isasync": true, + "name": "detachIso", + "params": [ + { + "description": "If true, ejects the ISO before detaching on VMware. Default: false", + "length": 255, + "name": "forced", + "required": false, + "since": "4.15.1", + "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - }, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Updates an existing cluster", - "isasync": false, - "name": "updateCluster", - "params": [ - { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "clustertype", - "required": false, - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - } - ], - "related": "addCluster", - "response": [ - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the Cluster name", - "name": "clustername", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the project name of the group", + "name": "project", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the cluster ID", - "name": "id", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - } - ] - }, - { - "description": "Upgrades a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "upgradeKubernetesCluster", - "params": [ + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the Kubernetes version for upgrade", - "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": true, - "type": "uuid" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster", - "response": [ - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "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 description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -74924,378 +74977,671 @@ "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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 user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - {}, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "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 date when this Kubernetes cluster was created", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "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": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "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": "List profile in ucs manager", - "isasync": false, - "name": "listUcsProfiles", + "description": "Creates a guest network IPv6 prefix.", + "isasync": true, + "name": "createGuestNetworkIpv6Prefix", "params": [ { - "description": "the id for the ucs manager", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "The /56 or higher IPv6 CIDR for network prefix.", "length": 255, - "name": "keyword", - "required": false, + "name": "prefix", + "required": true, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "", + "related": "listGuestNetworkIpv6Prefixes", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, - {}, { - "description": "ucs profile dn", - "name": "ucsdn", + "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": "the UUID of the latest async job acting on 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 storage providers.", - "isasync": false, - "name": "listStorageProviders", - "params": [ + }, { - "description": "the type of storage provider: either primary or image", - "length": 255, - "name": "type", - "required": true, + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", "type": "integer" }, + {} + ], + "since": "4.17.0.0" + }, + { + "description": " delete a Palo Alto firewall device", + "isasync": true, + "name": "deletePaloAltoFirewall", + "params": [ { - "description": "", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" } ], - "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the storage provider", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "the type of the storage provider: primary or image provider", - "name": "type", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "This command allows the user to query the seceret and API keys for the account", + "description": "Deletes a Pod.", "isasync": false, - "name": "getUserKeys", + "name": "deletePod", "params": [ { - "description": "ID of the user whose keys are required", + "description": "the ID of the Pod", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "related": "updatePod,createManagementNetworkIpRange", "required": true, "type": "uuid" } ], - "related": "registerUserKeys", "response": [ - {}, { - "description": "the api key of the registered user", - "name": "apikey", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the secret key of the registered user", - "name": "secretkey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "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.10.0" + } + ] }, { - "description": "update global load balancer rules.", - "isasync": true, - "name": "updateGlobalLoadBalancerRule", + "description": "Lists Tungsten-Fabric providers", + "isasync": false, + "name": "listTungstenFabricProviders", "params": [ { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "List by keyword", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the global load balancer rule", + "description": "", "length": 255, - "name": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "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": "", "length": 255, - "name": "gslblbmethod", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "", + "length": 255, + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, + {}, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -75303,1326 +75649,1410 @@ "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", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "List 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 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 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 load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" - }, - { - "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 name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the 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 ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the account of the load balancer rule", - "name": "account", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, - {}, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, { - "description": "name of the global load balancer rule", + "description": "Tungsten-Fabric provider name", "name": "name", "type": "string" }, {}, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" } ] }, { - "description": "Creates a condition for VM auto scaling", - "isasync": true, - "name": "createCondition", + "description": "Lists all DeploymentPlanners available.", + "isasync": false, + "name": "listDeploymentPlanners", "params": [ { - "description": "Value for which the Counter will be evaluated with the Operator selected.", + "description": "List by keyword", "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "description": "", "length": 255, - "name": "relationaloperator", - "required": true, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Deployment Planner name", + "name": "name", "type": "string" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ] + }, + { + "description": "Creates a role", + "isasync": false, + "name": "createRole", + "params": [ + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "account", + "name": "type", "required": false, "type": "string" }, { - "description": "the domain ID of the account.", + "description": "The description of the role", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of the Counter.", + "description": "Creates a role with this unique name", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional project for condition", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, "type": "uuid" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" } ], - "related": "", + "related": "importRole,listRoles,updateRole", "response": [ { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "the project name of the Condition", - "name": "project", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the id of the Condition", + "description": "the ID of the role", "name": "id", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {} + ], + "since": "4.9.0" + }, + { + "description": "Deletes a cluster.", + "isasync": false, + "name": "deleteCluster", + "params": [ { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" - }, - { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" + "description": "the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the Name of the Counter.", - "name": "countername", - "type": "string" } ] }, { - "description": "Lists projects and provides detailed information for listed projects", - "isasync": false, - "name": "listProjects", + "description": "Prepares a host for maintenance.", + "isasync": true, + "name": "prepareHostForMaintenance", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "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.", + "description": "the host ID", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "response": [ { - "description": "List projects by username", - "length": 255, - "name": "username", - "required": false, + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "list projects by display text", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "flag to display the resource icon for projects", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, - { - "description": "List projects by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "list projects by name", - "length": 255, + "description": "the name of the host", "name": "name", - "required": false, "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "list projects by state", - "length": 255, - "name": "state", - "required": false, + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "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 host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list projects by project ID", - "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "response": [ - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the ID of the host", + "name": "id", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, - {}, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, - {}, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the date this project was created", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the date and time the host was created", "name": "created", "type": "date" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, + {}, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the admin that annotated this host", + "name": "username", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Creates an account", + "description": "Removes specified region", "isasync": false, - "name": "createAccount", + "name": "removeRegion", "params": [ { - "description": "firstname", + "description": "ID of the region to delete", "length": 255, - "name": "firstname", + "name": "id", "required": true, - "type": "string" - }, + "type": "integer" + } + ], + "response": [ + {}, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "lastname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Get Volume's iSCSI Name", + "isasync": false, + "name": "getVolumeiScsiName", + "params": [ + { + "description": "CloudStack Volume UUID", "length": 255, - "name": "lastname", + "name": "volumeid", "required": true, "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", + "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Upload a data disk to the cloudstack cloud.", + "isasync": false, + "name": "getUploadParamsForVolume", + "params": [ + { + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", + "name": "checksum", "required": false, + "type": "string" + }, + { + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "Network domain for the account's networks", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "networkdomain", + "name": "account", "required": false, "type": "string" }, { - "description": "email", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "email", + "name": "format", "required": true, "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, "type": "uuid" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "accounttype", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "timezone", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "Image store uuid", "length": 255, - "name": "account", + "name": "imagestoreuuid", "required": false, "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "Unique username.", + "description": "the name of the volume/template/iso", "length": 255, - "name": "username", + "name": "name", "required": true, "type": "string" } ], - "related": "enableAccount,listAccounts,listAccounts", + "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "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": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, + {}, + {}, { - "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 volume which can be used by this account", - "name": "volumelimit", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "Updates an existing autoscale vm group.", + "isasync": true, + "name": "updateAutoScaleVmGroup", + "params": [ { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "an optional field, whether to the display the group to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the frequency in which the performance counters to be collected", + "length": 255, + "name": "interval", + "required": false, + "type": "integer" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "length": 255, + "name": "maxmembers", + "required": false, + "type": "integer" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the name of the autoscale vmgroup", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "list of scaleup autoscale policies", + "length": 255, + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "type": "list" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "length": 255, + "name": "minmembers", + "required": false, + "type": "integer" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "type": "list" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "response": [ { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, - {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, + {}, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the account owning the vm group", + "name": "account", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the name of the account", + "description": "the name of the autoscale vm group ", "name": "name", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the public port", + "name": "publicport", + "type": "string" + } + ] + }, + { + "description": "Updates an existing autoscale vm profile.", + "isasync": true, + "name": "updateAutoScaleVmProfile", + "params": [ + { + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "length": 255, + "name": "expungevmgraceperiod", + "required": false, + "type": "integer" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "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": "true if account is default, false otherwise", - "name": "isdefault", + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the profile to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18.1", + "type": "map" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "since": "4.18.0", + "type": "map" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18.1", + "type": "uuid" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the template of the auto deployed virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "length": 255, + "name": "counterparam", + "required": false, + "type": "map" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the service offering of the auto deployed virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.18.0", + "type": "uuid" + } + ], + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "response": [ + { + "description": "the project name of the vm profile", + "name": "project", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "name of the Domain the account belongs to", + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "Base 64 encoded VM user data", + "name": "userdata", + "type": "string" + }, + {}, + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", + "type": "string" + }, + {}, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain name of the vm profile", "name": "domain", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the name of the role", - "name": "rolename", - "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": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the 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 account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ], - "type": "list" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the account owning the instance group", + "name": "account", + "type": "string" } ] }, { - "description": "Allow or disallow a user to use SAML SSO", - "isasync": false, - "name": "authorizeSamlSso", + "description": "Enables an AutoScale Vm Group", + "isasync": true, + "name": "enableAutoScaleVmGroup", "params": [ { - "description": "The Identity Provider ID the user is allowed to get single signed on from", + "description": "the ID of the autoscale group", "length": 255, - "name": "entityid", - "related": "listIdps", - "required": false, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "required": true, + "type": "uuid" + } + ], + "related": "listAutoScaleVmGroups", + "response": [ + { + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO.", - "length": 255, - "name": "enable", - "required": true, + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "User uuid", + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" + }, + { + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the project name of the vm group", + "name": "project", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" + }, + { + "description": "the account owning the vm group", + "name": "account", + "type": "string" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" + }, + { + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes a snapshot of a disk volume.", + "isasync": true, + "name": "deleteSnapshot", + "params": [ + { + "description": "The ID of the zone for the snapshot", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "uuid" + }, + { + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "copySnapshot,revertSnapshot,listSnapshots", "required": true, "type": "uuid" } @@ -76630,9 +77060,9 @@ "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", @@ -76644,64 +77074,481 @@ "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": "Revert VM from a vmsnapshot.", - "isasync": true, - "name": "revertToVMSnapshot", + "description": "Lists guest network IPv6 prefixes", + "isasync": false, + "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "The ID of the vm snapshot", + "description": "", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "UUID of zone to which the IPv6 prefix belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "UUID of the IPv6 prefix.", + "length": 255, + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", + "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "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", + "related": "", "response": [ + { + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" + }, + { + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" + }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, { - "description": "Vm details in key/value pairs.", + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + {} + ], + "since": "4.17.0" + }, + { + "description": "List the virtual machines owned by the account.", + "isasync": false, + "name": "listVirtualMachines", + "params": [ + { + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list by the service offering", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" + }, + { + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" + }, + { + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "since": "4.4", + "type": "list" + }, + { + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "length": 255, + "name": "haenable", + "required": false, + "since": "4.15", + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "length": 255, "name": "details", + "required": false, + "type": "list" + }, + { + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "createInstanceGroup", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of AutoScaling VM Group", + "length": 255, + "name": "autoscalevmgroupid", + "related": "listAutoScaleVmGroups", + "required": false, + "since": "4.18.0", + "type": "uuid" + }, + { + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, "type": "map" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "type": "uuid" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "since": "4.16.0", + "type": "uuid" + }, + { + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "length": 255, + "name": "userdata", + "required": false, + "since": "4.18.0.0", "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "list vms by template", + "length": 255, + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "createSecurityGroup", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "length": 255, + "name": "state", + "required": false, + "type": "string" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + {}, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -76713,28 +77560,48 @@ "name": "project", "type": "string" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -76748,31 +77615,36 @@ "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 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 key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -76780,38 +77652,33 @@ "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "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" }, { @@ -76824,28 +77691,28 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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 project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -76854,58 +77721,78 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -76913,8 +77800,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -76923,13 +77810,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -76938,13 +77830,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -76953,36 +77845,21 @@ "type": "string" }, { - "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": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -76993,208 +77870,141 @@ ], "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 account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ID of the security group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the 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": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the project 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 name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, - {}, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, { - "description": "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -77202,162 +78012,155 @@ "name": "account", "type": "string" }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, { "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the state of the virtual machine", - "name": "state", - "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -77365,151 +78168,100 @@ "name": "name", "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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": "Base64 string containing the user data", - "name": "userdata", - "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": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", + "description": "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -77517,28 +78269,28 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the corresponding network", + "name": "networkid", "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 ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -77547,58 +78299,48 @@ "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -77606,293 +78348,256 @@ "name": "extradhcpoption", "type": "list" }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, { "description": "the isolation uri of the nic", "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists host tags", - "isasync": false, - "name": "listHostTags", - "params": [ + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, - {}, + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the host tag", - "name": "id", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the host tag", - "name": "name", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the host ID of the host tag", - "name": "hostid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" - } - ] - }, - { - "description": "Add a new guest OS type", - "isasync": true, - "name": "addGuestOs", - "params": [ + }, { - "description": "Optional name for Guest OS", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "ID of Guest OS category", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": true, - "type": "uuid" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the name of the OS type", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, { - "description": "is the guest OS user defined", - "name": "isuserdefined", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" } - ], - "since": "4.4.0" + ] }, { - "description": "add an annotation.", - "isasync": false, - "name": "addAnnotation", + "description": "Updates the information about Guest OS to Hypervisor specific name mapping", + "isasync": true, + "name": "updateGuestOsMapping", "params": [ { - "description": "the annotation text", + "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, - "name": "annotation", - "required": false, - "type": "string" + "name": "id", + "related": "updateGuestOsMapping", + "required": true, + "type": "uuid" }, { - "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", + "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", "length": 255, - "name": "entitytype", + "name": "osmappingcheckenabled", "required": false, - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the id of the entity to annotate", + "description": "Hypervisor specific name for this Guest OS", "length": 255, - "name": "entityid", - "required": false, + "name": "osnameforhypervisor", + "required": true, "type": "string" - }, - { - "description": "the annotation is visible for admins only", - "length": 255, - "name": "adminsonly", - "required": false, - "since": "4.16.0", - "type": "boolean" } ], - "related": "removeAnnotation,updateAnnotationVisibility", + "related": "", "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 type", + "name": "ostypeid", + "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, + {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { @@ -77900,789 +78605,487 @@ "name": "jobid", "type": "string" }, - { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" - }, - {}, - { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" - } + {} ], - "since": "4.11" + "since": "4.4.0" }, { - "description": "Removes a Guest OS Mapping.", + "description": "delete Tungsten-Fabric tag", "isasync": true, - "name": "removeGuestOsMapping", + "name": "deleteTungstenFabricTag", "params": [ { - "description": "ID of the guest OS mapping", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "id", - "related": "", + "name": "taguuid", + "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ], - "since": "4.4.0" + ] }, { - "description": "create Tungsten-Fabric service group", - "isasync": true, - "name": "createTungstenFabricServiceGroup", + "description": "Lists all available disk offerings.", + "isasync": false, + "name": "listDiskOfferings", "params": [ { - "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 protocol", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric service group name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "id of zone disk offering is associated with", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": true, + "required": false, + "since": "4.13", "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" }, { - "description": "Tungsten-Fabric service group name", + "description": "name of the disk offering", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Returns list of discovered SAML Identity Providers", - "isasync": false, - "name": "listIdps", - "params": [], - "related": "", - "response": [ - { - "description": "The IdP Entity ID", - "name": "id", - "type": "string" - }, - { - "description": "The IdP Organization Name", - "name": "orgName", - "type": "string" - }, - {}, - { - "description": "The IdP Organization URL", - "name": "orgUrl", - "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": "Registers an existing ISO into the CloudStack Cloud.", - "isasync": false, - "name": "registerIso", - "params": [ - { - "description": "Register ISO for the project", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "isdynamicallyscalable", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "boolean" - }, - { - "description": "the ID of the zone you wish to register the ISO to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "since": "4.17", "type": "uuid" }, { - "description": "true if you want this ISO to be featured", + "description": "listed offerings support disk encryption", "length": 255, - "name": "isfeatured", + "name": "encrypt", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "isextractable", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "an optional account name. Must be used with domainId.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "true if password reset feature is supported; default is false", + "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "passwordenabled", + "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": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ostypeid", - "related": "", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the name of the ISO", + "description": "ID of the disk offering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "", "length": 255, - "name": "bootable", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Image store UUID", + "description": "", "length": 255, - "name": "imagestoreuuid", + "name": "pagesize", "required": false, - "type": "string" - }, - { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "type": "integer" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "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": "string" + "type": "boolean" }, { - "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "checksum", + "name": "storagetype", "required": false, + "since": "4.19", "type": "string" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "List by keyword", "length": 255, - "name": "directdownload", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "createDiskOffering", "response": [ { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - {}, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "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 ID of the secondary storage host for the template", - "name": "hostid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "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": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "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": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the template ID", - "name": "id", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "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 disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "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 name of the secondary storage host for the template", - "name": "hostname", + "description": "the storage type for this disk offering", + "name": "storagetype", "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": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, - {}, { - "description": "the project name of the template", - "name": "project", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the status of the template", - "name": "status", + "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 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": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, + {}, { - "description": "the ID of the zone for this template", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" } ] }, { - "description": "Creates new NS Vpx", - "isasync": true, - "name": "deployNetscalerVpx", + "description": "Update password of a host/pool on management server.", + "isasync": false, + "name": "updateHostPassword", "params": [ { - "description": "the ID of the template for the virtual machine", + "description": "the new password for the host/cluster", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The network this ip address should be associated to.", + "description": "the cluster ID", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "if the password should also be updated on the hosts", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "update_passwd_on_host", + "required": false, + "type": "boolean" }, { - "description": "availability zone for the virtual machine", + "description": "the username for the host/cluster", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "username", "required": true, + "type": "string" + }, + { + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "required": false, "type": "uuid" } ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", "response": [ - { - "description": "device state", - "name": "lbdevicestate", - "type": "string" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "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": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "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": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - {}, + {} + ] + }, + { + "description": "adds a range of portable public IP's to a region", + "isasync": true, + "name": "createPortableIpRange", + "params": [ { - "description": "name of the provider", - "name": "provider", + "description": "the beginning IP address in the portable IP range", + "length": 255, + "name": "startip", + "required": true, "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the netmask of the portable IP range", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "Id of the Region", + "length": 255, + "name": "regionid", + "related": "addRegion,listRegions", + "required": true, + "type": "integer" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "VLAN id, if not specified defaulted to untagged", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - } - ] - }, - { - "description": "Lists the volumes of elastistor", - "isasync": false, - "name": "listElastistorVolume", - "params": [ + "description": "the ending IP address in the portable IP range", + "length": 255, + "name": "endip", + "required": true, + "type": "string" + }, { - "description": "the ID of the account", + "description": "the gateway for the portable IP range", "length": 255, - "name": "id", + "name": "gateway", "required": true, "type": "string" } @@ -78690,179 +79093,312 @@ "related": "", "response": [ { - "description": "the id of the volume", - "name": "id", + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", + "response": [ + { + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "VPC the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "syncronization", - "name": "sync", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, - {}, { - "description": "graceallowed", - "name": "graceallowed", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, + {}, { - "description": "deduplication", - "name": "deduplication", + "description": "portable IP range ID", + "name": "id", "type": "string" }, + { + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] + }, + {} + ], + "since": "4.2.0" }, { - "description": "add a baremetal pxe server", - "isasync": true, - "name": "addBaremetalPxeKickStartServer", + "description": "Updates an existing cluster", + "isasync": false, + "name": "updateCluster", "params": [ { - "description": "URL of the external pxe device", + "description": "the ID of the Cluster", "length": 255, - "name": "url", + "name": "id", + "related": "addCluster,updateCluster", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach external pxe device", + "description": "hypervisor type of the cluster", "length": 255, - "name": "username", - "required": true, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "Tftp root directory of PXE server", + "description": "hypervisor type of the cluster", "length": 255, - "name": "tftpdir", - "required": true, + "name": "clustertype", + "required": false, "type": "string" }, { - "description": "Pod Id", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "allocationstate", "required": false, - "type": "uuid" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "type of pxe device", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "pxeservertype", - "required": true, + "name": "managedstate", + "required": false, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "the cluster name", "length": 255, - "name": "password", - "required": true, + "name": "clustername", + "required": false, "type": "string" } ], - "related": "", + "related": "addCluster", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "device id of ", - "name": "id", + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "url", - "name": "url", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, - {} - ] - }, - { - "description": "deletes a range of portable public IP's associated with a region", - "isasync": true, - "name": "deletePortableIpRange", - "params": [ + {}, { - "description": "Id of the portable ip range", - "length": 255, + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the cluster ID", "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + } + ], + "type": "list" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -78871,822 +79407,1496 @@ ] }, { - "description": "Lists Nicira NVP devices", + "description": "Lists the VMs in a VMware Datacenter", "isasync": false, - "name": "listNiciraNvpDevices", + "name": "listVmwareDcVms", "params": [ { - "description": "List by keyword", + "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": "keyword", + "name": "vcenter", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "UUID of a linked existing vCenter", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "existingvcenterid", + "related": "addVmwareDc,listVmwareDcs", "required": false, "type": "uuid" }, { - "description": "nicira nvp device ID", + "description": "The password for specified username.", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "password", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Name of VMware datacenter.", "length": 255, - "name": "page", + "name": "datacentername", "required": false, - "type": "integer" - } + "type": "string" + }, + { + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } ], - "related": "addNiciraNvpDevice", + "related": "listUnmanagedInstances", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", "type": "integer" }, - {}, { - "description": "device name", - "name": "niciradevicename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, + {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", - "type": "string" + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "type": "string" + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" - } - ] - }, - { - "description": "Lists all alerts.", - "isasync": false, - "name": "listAlerts", - "params": [ + }, + {}, { - "description": "list by alert name", - "length": 255, - "name": "name", - "required": false, - "since": "4.3", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, { - "description": "list by alert type", - "length": 255, - "name": "type", - "required": false, + "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", "type": "integer" - }, + } + ] + }, + { + "description": "Deletes a Cisco ASA 1000v appliance", + "isasync": false, + "name": "deleteCiscoAsa1000vResource", + "params": [ { - "description": "the ID of the alert", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "id", - "related": "listAlerts", - "required": false, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": true, "type": "uuid" } ], - "related": "", "response": [ {}, { - "description": "the name of the alert", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" - }, - { - "description": "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 id of the alert", - "name": "id", - "type": "string" - }, - { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - { - "description": "description of the alert", - "name": "description", - "type": "string" - } + {} ] }, { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", + "description": "Upgrades a running CloudManaged Kubernetes cluster", "isasync": true, - "name": "deployVirtualMachine", + "name": "upgradeKubernetesCluster", "params": [ { - "description": "used to specify the vApp properties.", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "properties", - "required": false, - "since": "4.15", - "type": "map" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "the ID of the Kubernetes version for upgrade", "length": 255, - "name": "datadiskofferinglist", - "required": false, - "since": "4.11", - "type": "map" - }, + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": true, + "type": "uuid" + } + ], + "related": "createKubernetesCluster,startKubernetesCluster", + "response": [ { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", - "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "list" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "the ip address for default vm's network", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "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 size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "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": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", - "length": 255, - "name": "startvm", - "required": false, - "type": "boolean" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "host name for the virtual machine", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", - "length": 255, - "name": "size", - "required": false, - "type": "long" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", - "required": false, + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", - "length": 255, - "name": "nicmultiqueuenumber", - "required": false, - "since": "4.18", - "type": "integer" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the 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": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, + {}, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, + "description": "the account associated with the Kubernetes cluster", "name": "account", - "required": false, "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 cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "the ID of the Userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", - "length": 255, - "name": "iothreadsenabled", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "an optional group for the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the ipv6 address for default vm's network", - "length": 255, - "name": "ip6address", - "required": false, + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", - "length": 255, - "name": "nicnetworklist", - "required": false, - "since": "4.15", - "type": "map" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "since": "4.13", - "type": "uuid" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "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 name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "Enable packed virtqueues or not.", - "length": 255, - "name": "nicpackedvirtqueuesenabled", - "required": false, - "since": "4.18", - "type": "boolean" + "description": "the name of the Kubernetes cluster", + "name": "name", + "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": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", - "length": 255, - "name": "affinitygroupids", - "related": "", - "required": false, - "type": "list" + "description": "the description of the Kubernetes cluster", + "name": "description", + "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 name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "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 name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "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": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "List profile in ucs manager", + "isasync": false, + "name": "listUcsProfiles", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "deploymentplanner", + "name": "keyword", "required": false, - "since": "4.4", "type": "string" }, { - "description": "Deploy vm for the project", + "description": "the id for the ucs manager", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": false, + "name": "ucsmanagerid", + "related": "addUcsManager", + "required": true, "type": "uuid" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "", "length": 255, - "name": "keypairs", + "name": "pagesize", "required": false, - "since": "4.17", - "type": "list" + "type": "integer" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "", "length": 255, - "name": "keyboard", + "name": "page", "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "ucs profile dn", + "name": "ucsdn", + "type": "string" + } + ] + }, + { + "description": "Lists storage providers.", + "isasync": false, + "name": "listStorageProviders", + "params": [ + { + "description": "the type of storage provider: either primary or image", "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.4", - "type": "long" + "name": "type", + "required": true, + "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", + "description": "", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "", "length": 255, - "name": "displayvm", + "name": "page", "required": false, - "since": "4.2", - "type": "boolean" + "type": "integer" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "List by keyword", "length": 255, - "name": "keypair", + "name": "keyword", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the name of the storage provider", + "name": "name", + "type": "string" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", - "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the mac address for default vm's network", - "length": 255, - "name": "macaddress", - "required": false, + "description": "the type of the storage provider: primary or image provider", + "name": "type", "type": "string" }, + {}, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "This command allows the user to query the seceret and API keys for the account", + "isasync": false, + "name": "getUserKeys", + "params": [ + { + "description": "ID of the user whose keys are required", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, "type": "uuid" + } + ], + "related": "registerUserKeys", + "response": [ + { + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" }, { - "description": "Controls specific policies on IO", - "length": 255, - "name": "iodriverpolicy", - "required": false, + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", - "length": 255, - "name": "iptonetworklist", - "required": false, - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.10.0" + }, + { + "description": "update global load balancer rules.", + "isasync": true, + "name": "updateGlobalLoadBalancerRule", + "params": [ + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, + "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "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": "diskofferingid", - "related": "createDiskOffering", + "name": "gslblbmethod", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "availability zone for the virtual machine", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "updateGlobalLoadBalancerRule", "required": true, "type": "uuid" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", - "type": "string" - }, - { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", - "length": 1048576, - "name": "userdata", + "name": "gslbstickysessionmethodname", "required": false, "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", + "related": "", "response": [ { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the current status of the latest async job acting 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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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": "global load balancer rule ID", + "name": "id", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the name of the affinity group", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the load balancer", "name": "name", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the project id of the load balancer", "name": "projectid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the public ip address id", + "name": "publicipid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + } + ] + }, + { + "description": "Creates a condition for VM auto scaling", + "isasync": true, + "name": "createCondition", + "params": [ + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" + }, + { + "description": "ID of the Counter.", + "length": 255, + "name": "counterid", + "related": "createCounter,listCounters", + "required": true, + "type": "uuid" + }, + { + "description": "an optional project for condition", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "the account of the condition. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the domain ID of the account.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the id of the Condition", + "name": "id", + "type": "string" + }, + { + "description": "the Id of the Counter.", + "name": "counterid", + "type": "string" + }, + { + "description": "the owner of the Condition.", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "type": "string" + }, + { + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, + { + "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", + "type": "string" + }, + { + "description": "the project name of the Condition", + "name": "project", + "type": "string" + }, + { + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" + }, + {}, + { + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, + { + "description": "the domain name of the owner.", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id of the Condition owner", + "name": "domainid", + "type": "string" + } + ] + }, + { + "description": "Lists projects and provides detailed information for listed projects", + "isasync": false, + "name": "listProjects", + "params": [ + { + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, + "type": "list" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List projects by username", + "length": 255, "name": "username", + "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "flag to display the resource icon for projects", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list projects by state", + "length": 255, + "name": "state", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list projects by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List projects by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list projects by project ID", + "length": 255, "name": "id", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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 projects by display text", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + } + ], + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "response": [ + { + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the domain id the project belongs to", "name": "domainid", "type": "string" }, { - "description": "the 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 total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total 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 primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with vm", "name": "tags", "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -79695,1121 +80905,946 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + {}, + { + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, + {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an account", + "isasync": false, + "name": "createAccount", + "params": [ + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": false, + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, + { + "description": "Creates the user under the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "email", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, + "type": "string" + } + ], + "related": "enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, - {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the domain name of the security group", + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "the name of the role", + "name": "rolename", + "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the timezone user was created in", + "name": "timezone", "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" } ], - "type": "set" + "type": "list" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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 networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - } - ], - "type": "set" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the account", + "name": "name", "type": "string" - } - ] - }, - { - "description": "Upgrades router to use newer template", - "isasync": false, - "name": "upgradeRouterTemplate", - "params": [ + }, { - "description": "upgrades all routers within the specified cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "upgrades all routers within the specified pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "upgrades all routers owned by the specified account", - "length": 255, - "name": "account", - "required": false, + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "upgrades router with the specified Id", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", - "required": false, - "type": "uuid" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "upgrades all routers owned by the specified domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "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 total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total 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 primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { - "description": "Cancels host maintenance.", + "description": "Revert VM from a vmsnapshot.", "isasync": true, - "name": "cancelHostMaintenance", + "name": "revertToVMSnapshot", "params": [ { - "description": "the host ID", + "description": "The ID of the vm snapshot", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "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 host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -80817,569 +81852,1097 @@ "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "Host 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 last annotation set on this host by an admin", - "name": "annotation", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the Pod name of the host", - "name": "podname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, + {}, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "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 ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the ID of 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": "events available for the host", - "name": "events", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" - } - ] - }, - { - "description": "Lists all VLAN IP ranges.", - "isasync": false, - "name": "listVlanIpRanges", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the Pod ID of the VLAN IP range", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", - "length": 255, - "name": "vlan", - "required": false, + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "physical network id of the VLAN IP range", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "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": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "updateVlanIpRange,dedicatePublicIpRange", - "response": [ - { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, + {}, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + } + ], + "type": "set" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Lists host tags", + "isasync": false, + "name": "listHostTags", + "params": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the description of the VLAN IP range", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the ID of the host tag", + "name": "id", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "description": "the host ID of the host tag", + "name": "hostid", + "type": "long" }, + {}, + {}, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the name of the host tag", + "name": "name", "type": "string" } ] }, { - "description": "Updates a Zone.", - "isasync": false, - "name": "updateZone", + "description": "Add a new guest OS type", + "isasync": true, + "name": "addGuestOs", "params": [ { - "description": "the details for the Zone", + "description": "Unique display name for Guest OS", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "osdisplayname", + "required": true, + "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "ID of Guest OS category", "length": 255, - "name": "internaldns1", - "required": false, - "type": "string" + "name": "oscategoryid", + "related": "listOsCategories", + "required": true, + "type": "uuid" }, { - "description": "the dns search order list", + "description": "Map of (key/value pairs)", "length": 255, - "name": "dnssearchorder", + "name": "details", "required": false, - "type": "list" + "type": "map" }, { - "description": "the guest CIDR address for the Zone", + "description": "whether this guest OS is available for end users", "length": 255, - "name": "guestcidraddress", + "name": "forDisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "Optional name for Guest OS", "length": 255, - "name": "allocationstate", + "name": "name", "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the Zone", - "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the name/description of the OS type", + "name": "description", + "type": "string" }, { - "description": "sort key of the zone, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the second DNS for the Zone", - "length": 255, - "name": "dns2", - "required": false, + "description": "the name of the OS type", + "name": "name", "type": "string" }, + {}, { - "description": "the name of the Zone", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second internal DNS for the Zone", - "length": 255, - "name": "internaldns2", - "required": false, + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", - "length": 255, - "name": "ip6dns1", - "required": false, + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", - "length": 255, - "name": "domain", - "required": false, + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", - "length": 255, - "name": "ip6dns2", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + {} + ], + "since": "4.4.0" + }, + { + "description": "add an annotation.", + "isasync": false, + "name": "addAnnotation", + "params": [ + { + "description": "the annotation is visible for admins only", "length": 255, - "name": "ispublic", + "name": "adminsonly", "required": false, + "since": "4.16.0", "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", + "description": "the id of the entity to annotate", "length": 255, - "name": "dhcpprovider", + "name": "entityid", "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "the annotation text", "length": 255, - "name": "dns1", + "name": "annotation", "required": false, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", "length": 255, - "name": "localstorageenabled", + "name": "entitytype", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "createZone,listZones,listZones", + "related": "removeAnnotation,updateAnnotationVisibility", "response": [ { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "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": "Zone name", - "name": "name", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "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", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "Removes a Guest OS Mapping.", + "isasync": true, + "name": "removeGuestOsMapping", + "params": [ + { + "description": "ID of the guest OS mapping", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "description": "true if operation is executed successfully", + "name": "success", "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", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "create Tungsten-Fabric service group", + "isasync": true, + "name": "createTungstenFabricServiceGroup", + "params": [ { - "description": "Zone id", - "name": "id", + "description": "Tungsten-Fabric service group name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "Tungsten-Fabric service group protocol", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Tungsten-Fabric service group end port", + "length": 255, + "name": "endport", + "required": true, + "type": "integer" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric service group start port", + "length": 255, + "name": "startport", + "required": true, "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + {}, + { + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" }, { @@ -81388,408 +82951,296 @@ "type": "integer" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "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": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", "type": "string" + } + ] + }, + { + "description": "Registers an existing ISO into the CloudStack Cloud.", + "isasync": false, + "name": "registerIso", + "params": [ + { + "description": "Register ISO for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - } - ], - "type": "list" + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the name of the ISO", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "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 first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" - } - ] - }, - { - "description": "Extracts volume", - "isasync": true, - "name": "extractVolume", - "params": [ + }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "mode", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ID of the zone where the volume is located", + "description": "true if password reset feature is supported; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, "name": "zoneid", - "related": "createZone,listZones,listZones", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "the ID of the volume", + "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, + { + "description": "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 url to which the volume would be extracted", + "description": "Image store UUID", + "length": 255, + "name": "imagestoreuuid", + "required": false, + "type": "string" + }, + { + "description": "the URL to where the ISO is currently being hosted", "length": 2048, "name": "url", - "required": false, + "required": true, "type": "string" } ], - "related": "extractTemplate", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "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" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "description": "the URL which the template/iso is registered from", "name": "url", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "", - "name": "resultstring", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the extracted object", - "name": "state", - "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 mode of extraction - upload or download", - "name": "extractMode", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" - } - ] - }, - { - "description": "Lists project's accounts", - "isasync": false, - "name": "listProjectAccounts", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "list accounts of the project by project role id", - "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", - "required": false, - "type": "uuid" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "list accounts of the project by role", - "length": 255, - "name": "role", - "required": false, + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "list invitation by user ID", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list accounts of the project by account name", - "length": 255, - "name": "account", - "required": false, + "description": "the template ID", + "name": "id", "type": "string" - } - ], - "related": "activateProject,suspendProject,updateProject", - "response": [ + }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the list of resource tags associated with vm", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "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 domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -81798,356 +83249,365 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the 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" } ], - "type": "list" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "type": "set" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, + {}, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the size of the template", + "name": "size", "type": "long" }, - {}, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, + {} + ] + }, + { + "description": "Lists Cisco ASA 1000v appliances", + "isasync": false, + "name": "listCiscoAsa1000vResources", + "params": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "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": "Cisco ASA 1000v resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": false, + "type": "uuid" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": false, "type": "string" - }, + } + ], + "related": "addCiscoAsa1000vResource", + "response": [ + {}, + {}, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {}, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" - } - ], - "since": "3.0.0" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + {} + ] }, { - "description": "Updates an existing autoscale policy.", + "description": "Creates new NS Vpx", "isasync": true, - "name": "updateAutoScalePolicy", + "name": "deployNetscalerVpx", "params": [ { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "length": 255, - "name": "conditionids", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "The network this ip address should be associated to.", "length": 255, - "name": "name", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the ID of the autoscale policy", + "description": "availability zone for the virtual machine", "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } ], - "related": "listAutoScalePolicies", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", "response": [ { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, + {}, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", "type": "list" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "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": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, - {}, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "the project name of the autoscale policy", - "name": "project", + "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", @@ -82159,998 +83619,1248 @@ "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "device state", + "name": "lbdevicestate", + "type": "string" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" } ] }, { - "description": "Creates a disk offering.", + "description": "Lists the volumes of elastistor", "isasync": false, - "name": "createDiskOffering", + "name": "listElastistorVolume", "params": [ { - "description": "length (in seconds) of the burst", + "description": "the ID of the account", "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "type": "long" - }, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" + "description": "graceallowed", + "name": "graceallowed", + "type": "string" }, { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": true, + "description": "synchronization", + "name": "sync", "type": "string" }, { - "description": "max iops of the disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", + "description": "deduplication", + "name": "deduplication", "type": "string" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the id of the volume", + "name": "id", "type": "string" }, { - "description": "min iops of the disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" + "description": "the name of the volume", + "name": "name", + "type": "string" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", - "length": 255, - "name": "storagepolicy", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "compression", + "name": "compression", + "type": "string" }, + {}, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "deletes a range of portable public IP's associated with a region", + "isasync": true, + "name": "deletePortableIpRange", + "params": [ { - "description": "burst bytes read rate of the disk offering", + "description": "Id of the portable ip range", "length": 255, - "name": "bytesreadratemax", - "required": false, - "type": "long" - }, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the storage type of the disk offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", - "length": 255, - "name": "disksize", - "required": false, - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {} + ] + }, + { + "description": "add a baremetal pxe server", + "isasync": true, + "name": "addBaremetalPxeKickStartServer", + "params": [ { - "description": "io requests write rate of the disk offering", + "description": "the Physical Network ID", "length": 255, - "name": "iopswriterate", - "required": false, - "type": "long" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "name": "tftpdir", + "required": true, + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" + "name": "username", + "required": true, + "type": "string" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", - "required": false, + "description": "URL of the external pxe device", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "burst bytes write rate of the disk offering", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "byteswriteratemax", - "required": false, - "type": "long" + "name": "password", + "required": true, + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "type of pxe device", "length": 255, - "name": "iopswriteratemax", - "required": false, - "type": "long" + "name": "pxeservertype", + "required": true, + "type": "string" }, { - "description": "whether disk offering size is custom or not", + "description": "Pod Id", "length": 255, - "name": "customized", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "boolean" - }, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "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": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "device id of ", + "name": "id", + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "length": 255, - "name": "hypervisorsnapshotreserve", - "required": false, + "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 offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "type": "long" + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" }, + {}, { - "description": "Volumes using this offering should be encrypted", + "description": "url", + "name": "url", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + {} + ] + }, + { + "description": "Lists Nicira NVP devices", + "isasync": false, + "name": "listNiciraNvpDevices", + "params": [ + { + "description": "nicira nvp device ID", "length": 255, - "name": "encrypt", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "the Physical Network ID", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "since": "4.13", - "type": "list" + "type": "uuid" }, { - "description": "details to specify disk offering parameters", + "description": "List by keyword", "length": 255, - "name": "details", + "name": "keyword", "required": false, - "since": "4.16", - "type": "map" + "type": "string" }, { - "description": "bytes write rate of the disk offering", + "description": "", "length": 255, - "name": "byteswriterate", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "whether disk offering iops is custom or not", + "description": "", "length": 255, - "name": "customizediops", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "", + "related": "addNiciraNvpDevice", "response": [ { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" - }, - { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - {}, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {} + ] + }, + { + "description": "Lists all alerts.", + "isasync": false, + "name": "listAlerts", + "params": [ { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" - }, - { - "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": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the ID of the alert", + "length": 255, + "name": "id", + "related": "listAlerts", + "required": false, + "type": "uuid" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "list by alert type", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" - }, - { - "description": "unique ID of the disk offering", - "name": "id", + "description": "list by alert name", + "length": 255, + "name": "name", + "required": false, + "since": "4.3", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, { - "description": "the date this disk offering was created", - "name": "created", + "description": "the date and time the alert was sent", + "name": "sent", "type": "date" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the id of the alert", + "name": "id", + "type": "string" }, - {}, { - "description": "the name of the disk offering", + "description": "the name of the alert", "name": "name", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "description of the alert", + "name": "description", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "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": "Lists all volumes.", - "isasync": false, - "name": "listVolumes", + "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", + "isasync": true, + "name": "deployVirtualMachine", "params": [ { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "", + "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": "page", + "name": "rootdisksize", "required": false, - "type": "integer" + "since": "4.4", + "type": "long" }, { - "description": "the ID of the disk volume", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "clusterid", + "related": "addCluster", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "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": "ids", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "keyboard", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { - "description": "list volumes on specified host", + "description": "used to specify the vApp properties.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "properties", "required": false, - "type": "uuid" + "since": "4.15", + "type": "map" }, { - "description": "list volumes by disk offering", + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", "length": 255, "name": "diskofferingid", - "related": "", + "related": "createDiskOffering", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ip address for default vm's network", "length": 255, - "name": "listall", + "name": "ipaddress", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "details", "required": false, - "type": "uuid" + "since": "4.3", + "type": "map" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", + "length": 1048576, + "name": "userdata", "required": false, "type": "string" }, { - "description": "the name of the disk volume", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "host name for the virtual machine", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "the mac address for default vm's network", "length": 255, - "name": "listsystemvms", + "name": "macaddress", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the availability zone", + "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": "zoneid", - "related": "createZone,listZones,listZones", + "name": "securitygroupnames", + "related": "createSecurityGroup", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the ID of the virtual machine", + "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": "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": "securitygroupids", + "related": "createSecurityGroup", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "isrecursive", + "name": "dynamicscalingenabled", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "displayvolume", + "name": "keypair", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the pod id the disk volume belongs to", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "keypairs", "required": false, - "type": "uuid" + "since": "4.17", + "type": "list" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.3", - "type": "string" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "account", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "ip6address", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the type of disk volume", - "length": 255, - "name": "type", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, + "since": "4.12", "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "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": "state", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Userdata", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "userdataid", + "related": "", "required": false, + "since": "4.18", "type": "uuid" - } - ], - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "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 bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "true if start vm after creating; defaulted to true if not specified", + "length": 255, + "name": "startvm", + "required": false, + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "length": 255, + "name": "iptonetworklist", + "required": false, + "type": "map" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "length": 255, + "name": "iothreadsenabled", + "required": false, "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "since": "4.11", + "type": "map" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "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 display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "length": 255, + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "list" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, - {}, { - "description": "name of the virtual machine", - "name": "vmname", + "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": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "bootmode", + "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "the 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": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "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": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "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 domain associated with the tag", + "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" } ], "type": "set" }, { - "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "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 state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -83158,443 +84868,652 @@ "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + {}, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" - } - ] - }, - { - "description": "Creates a load balancer health check policy", - "isasync": true, - "name": "createLBHealthCheckPolicy", - "params": [ + }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", - "length": 255, - "name": "responsetimeout", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, + {}, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", - "length": 255, - "name": "unhealthythreshold", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the description of the load balancer health check policy", - "length": 255, - "name": "description", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "HTTP ping path", - "length": 255, - "name": "pingpath", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Amount of time between health checks (1 sec - 20940 sec)", - "length": 255, - "name": "intervaltime", - "required": false, - "type": "integer" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "length": 255, - "name": "healthythreshold", - "required": false, - "type": "integer" - } - ], - "related": "listLBHealthCheckPolicies", - "response": [ - {}, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, - {}, { - "description": "the 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 account of the HealthCheck policy", - "name": "account", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", + "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": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the affinity group", + "name": "name", + "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the LB HealthCheck policy ID", + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" } ], - "type": "list" - } - ], - "since": "4.2.0" - }, - { - "description": "Locks a user account", - "isasync": false, - "name": "lockUser", - "params": [ + "type": "set" + }, { - "description": "Locks user by user ID.", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", - "response": [ + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the account name of the user", - "name": "account", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, - {}, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - } - ] - }, - { - "description": "Checks if the Cloudian Connector is enabled", - "isasync": false, - "name": "cloudianIsEnabled", - "params": [], - "related": "", - "response": [ + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, - {}, { - "description": "the Cloudian Management Console base URL", - "name": "url", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" } - ], - "since": "4.11.0" + ] }, { - "description": "Lists load balancer health check policies.", + "description": "Upgrades router to use newer template", "isasync": false, - "name": "listLBHealthCheckPolicies", + "name": "upgradeRouterTemplate", "params": [ { - "description": "the ID of the health check policy", + "description": "upgrades all routers within the specified cluster", "length": 255, - "name": "id", - "related": "listLBHealthCheckPolicies", + "name": "clusterid", + "related": "addCluster", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "upgrades all routers within the specified pod", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "upgrades all routers owned by the specified account", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "upgrades all routers within the specified zone", "length": 255, - "name": "fordisplay", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "upgrades router with the specified Id", "length": 255, - "name": "page", + "name": "id", + "related": "destroyRouter,listRouters", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "upgrades all routers owned by the specified domain", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - {}, - { - "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 domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -83605,1267 +85524,1171 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, {}, - { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", - "response": [ - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - } - ], - "type": "list" - } - ], - "since": "4.2.0" + {} + ] }, { - "description": "Creates a network", - "isasync": false, - "name": "createNetwork", + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", "params": [ { - "description": "ID of the network in an external system.", + "description": "the host ID", "length": 255, - "name": "externalid", - "required": false, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "response": [ + { + "description": "the hypervisor version", + "name": "hypervisorversion", "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the display text of the network", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the physical network ID the network belongs to", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "Account that will own the network. Account should be under the selected domain", - "length": 255, - "name": "account", - "required": false, + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", - "length": 255, - "name": "acltype", - "required": false, - "type": "string" + "description": "true if 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": "Network ACL ID associated for the network", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the name of the network", - "length": 255, - "name": "name", - "required": true, + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the isolated private VLAN for this network", - "length": 255, - "name": "isolatedpvlan", - "required": false, + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", - "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", - "length": 255, - "name": "ip6gateway", - "required": false, - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "IPV4 address to be assigned to a router in a shared network", - "length": 255, - "name": "routerip", - "required": false, - "since": "4.16", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, - { - "description": "the zone ID for the network", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the ID or VID of the network", - "length": 255, - "name": "vlan", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", - "length": 255, - "name": "netmask", - "required": false, + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the first IPv4 DNS for the network", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "length": 255, - "name": "tungstenvirtualrouteruuid", - "required": false, + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the VPC network belongs to", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", - "length": 255, - "name": "gateway", - "required": false, - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the beginning IP address in the network IP range", - "length": 255, - "name": "startip", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IPV6 address to be assigned to a router in a shared network", - "length": 255, - "name": "routeripv6", - "required": false, - "since": "4.16", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the isolated private VLAN type for this network", - "length": 255, - "name": "isolatedpvlantype", - "required": false, + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "domain ID of the account owning a network. If no account is provided then network will be assigned to the caller account and domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", - "length": 255, - "name": "hideipaddressusage", - "required": false, - "type": "boolean" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "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 amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "an optional project for the network", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", - "length": 255, - "name": "endip", - "required": false, + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "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": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "MTU to be configured on the network VR's private interface(s)", - "length": 255, - "name": "privatemtu", - "required": false, - "since": "4.18.0", - "type": "integer" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, + {}, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "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 last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "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", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "the cluster name of the host", + "name": "clustername", + "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 outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the id of the network", - "name": "id", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "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", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + } + ] + }, + { + "description": "Lists all VLAN IP ranges.", + "isasync": false, + "name": "listVlanIpRanges", + "params": [ { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "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": "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": "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" - } - ], - "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", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the name of the network", - "name": "name", + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the ID of the VLAN IP range", + "length": 255, + "name": "id", + "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "required": false, + "type": "uuid" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "true if VLAN is of Virtual type, false if Direct", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "the Zone ID of the VLAN IP range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "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": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the Pod ID of the VLAN IP range", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, + "description": "physical network id of the VLAN IP range", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + } + ], + "related": "updateVlanIpRange,dedicatePublicIpRange", + "response": [ { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "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", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "The external id of the network", - "name": "externalid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "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 cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, {}, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" } ] }, { - "description": "Lists all available network offerings.", + "description": "Updates a Zone.", "isasync": false, - "name": "listNetworkOfferings", + "name": "updateZone", "params": [ { - "description": "the availability of network offering. Default value is required", + "description": "the second DNS for the Zone", "length": 255, - "name": "availability", + "name": "dns2", "required": false, "type": "string" }, { - "description": "list network offerings by state", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "state", + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "the tags for the network offering.", + "description": "the details for the Zone", "length": 255, - "name": "specifyvlan", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "", + "description": "sort key of the zone, integer", "length": 255, - "name": "page", + "name": "sortkey", "required": false, "type": "integer" }, { - "description": "list network offerings available for network creation in specific domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "since": "4.13", - "type": "uuid" - }, - { - "description": "list network offerings by name", + "description": "the name of the Zone", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "ip6dns1", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "pagesize", + "name": "ispublic", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list network offerings by display text", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "displaytext", + "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "the first DNS for the Zone", "length": 255, - "name": "forvpc", + "name": "dns1", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if offering has tags specified", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "istagged", + "name": "ip6dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "the dns search order list", "length": 255, - "name": "guestiptype", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "the guest CIDR address for the Zone", + "length": 255, + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "list network offerings supporting certain services", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "supportedservices", + "name": "localstorageenabled", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "list network offerings by ID", + "description": "the ID of the Zone", "length": 255, "name": "id", - "related": "listNetworkOfferings", - "required": false, + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "sourcenatsupported", + "name": "domain", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "isdefault", + "name": "allocationstate", "required": false, - "type": "boolean" + "type": "string" }, { - "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": "the first internal DNS for the Zone", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "internaldns1", "required": false, - "type": "uuid" + "type": "string" + } + ], + "related": "createZone,listZones,listZones", + "response": [ + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" }, { - "description": "list by traffic type", - "length": 255, - "name": "traffictype", - "required": false, + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", - "length": 255, - "name": "specifyipranges", - "required": false, + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, + {}, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the list of supported services", - "name": "service", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the service name", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, + {}, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, - {}, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "the 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": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "an alternate display text of the network offering.", + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the display text of the zone", "name": "displaytext", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, - {}, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + } + ] + }, + { + "description": "Extracts volume", + "isasync": true, + "name": "extractVolume", + "params": [ + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "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": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" + } + ], + "related": "downloadImageStoreObject,extractTemplate", + "response": [ + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" + "description": "the status of the extraction", + "name": "status", + "type": "string" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "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 account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" }, + {}, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - } + "description": "", + "name": "resultstring", + "type": "string" + }, + {} ] }, { - "description": "Lists dedicated pods.", + "description": "Lists project's accounts", "isasync": false, - "name": "listDedicatedPods", + "name": "listProjectAccounts", "params": [ { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "list accounts of the project by role", "length": 255, - "name": "account", + "name": "role", "required": false, "type": "string" }, @@ -84877,26 +86700,26 @@ "type": "string" }, { - "description": "list dedicated pods by affinity group", + "description": "list accounts of the project by account name", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list accounts of the project by project role id", "length": 255, - "name": "page", + "name": "projectroleid", + "related": "updateProjectRole", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the domain associated with the pod", + "description": "ID of the project", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": true, "type": "uuid" }, { @@ -84907,41 +86730,41 @@ "type": "integer" }, { - "description": "the ID of the pod", + "description": "list invitation by user ID", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "", + "related": "activateProject,suspendProject,updateProject", "response": [ - {}, - { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", - "type": "string" - }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "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", + "type": "long" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { @@ -84950,1135 +86773,917 @@ "type": "string" }, { - "description": "the Name of the Pod", - "name": "podname", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" - } - ] - }, - { - "description": "Attempts Migration of a VM with its volumes to a different host", - "isasync": true, - "name": "migrateVirtualMachineWithVolume", - "params": [ - { - "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, - "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": true, - "type": "uuid" }, { - "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", - "length": 255, - "name": "autoselect", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", - "length": 255, - "name": "migrateto", - "required": false, - "type": "map" - } - ], - "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, - {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the total number of vpcs the project 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 secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated with vm", + "name": "tags", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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": "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag 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" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the state of the project", + "name": "state", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the total volume available for this project", + "name": "volumeavailable", "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 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" - }, - { - "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", - "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" - } - ], - "type": "set" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates an existing autoscale policy.", + "isasync": true, + "name": "updateAutoScalePolicy", + "params": [ + { + "description": "the duration in which the conditions have to be true before action is taken", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "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 name of the virtual machine", + "description": "the name of the autoscale policy", + "length": 255, "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "uuid" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "", + "required": false, + "type": "list" + } + ], + "related": "listAutoScalePolicies", + "response": [ + { + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + { + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, + {} + ] + }, + { + "description": "Creates a disk offering.", + "isasync": false, + "name": "createDiskOffering", + "params": [ + { + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" + }, { - "description": "Vm details in key/value pairs.", + "description": "Volumes using this offering should be encrypted", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "whether disk offering iops is custom or not", + "length": 255, + "name": "customizediops", + "required": false, + "type": "boolean" + }, + { + "description": "details to specify disk offering parameters", + "length": 255, "name": "details", + "required": false, + "since": "4.16", "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", + "required": false, + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "type": "long" + }, + { + "description": "whether disk offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "type": "boolean" + }, + { + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "length": 255, + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.14", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the storage type of the disk offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "length": 255, + "name": "hypervisorsnapshotreserve", + "required": false, "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "io requests write rate of the disk offering", + "length": 255, + "name": "iopswriterate", + "required": false, + "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 group ID of the virtual machine", - "name": "groupid", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "max iops of the disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "length": 255, + "name": "disksize", + "required": false, + "type": "long" + }, + { + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "type": "long" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "length": 255, + "name": "provisioningtype", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "list" + }, + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "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 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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - } - ], - "type": "set" + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "min iops of the disk offering", + "length": 255, + "name": "miniops", + "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", + "length": 255, + "name": "disksizestrictness", + "required": false, + "since": "4.17", "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "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" - } - ], - "type": "set" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, + {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "the date when this virtual machine was created", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the date this disk offering was created", "name": "created", "type": "date" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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 cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" + }, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "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 size of the disk offering in GB", + "name": "disksize", + "type": "long" } ] }, { - "description": "Lists VPCs", + "description": "Lists all volumes.", "isasync": false, - "name": "listVPCs", + "name": "listVolumes", "params": [ { - "description": "list VPC by id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "displayvolume", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "pagesize", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "integer" + "since": "4.3", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "name": "ids", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "List by keyword", + "description": "list volumes on specified host", "length": 255, - "name": "keyword", + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "List by display text of the VPC", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "displaytext", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to display the resource icon for VPCs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showicon", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the name of the disk volume", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { "description": "", @@ -86088,340 +87693,375 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list by zone", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "listsystemvms", "required": false, - "type": "uuid" + "since": "4.18", + "type": "boolean" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "the ID of the disk volume", "length": 255, - "name": "cidr", + "name": "id", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the availability zone", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list VPCs by restartRequired option", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "restartrequired", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list VPC supporting certain services", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "supportedservices", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "makes the API's response contains only the resource count", "length": 255, - "name": "listall", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, { - "description": "list by name of the VPC", + "description": "the ID of the virtual machine", "length": 255, - "name": "name", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "list VPCs by state", + "description": "the type of disk volume", "length": 255, - "name": "state", + "name": "type", "required": false, "type": "string" }, { - "description": "list by ID of the VPC offering", + "description": "list volumes by disk offering", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "diskofferingid", + "related": "", "required": false, + "since": "4.4", "type": "uuid" } ], - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "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": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "state of the virtual machine", + "name": "vmstate", + "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": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, - {}, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "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": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "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": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + {}, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "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": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the list of resource tags associated with the project", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -86430,263 +88070,318 @@ "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - } - ] - }, - { - "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", - "isasync": true, - "name": "runDiagnostics", - "params": [ - { - "description": "Additional command line options that apply for each command", - "length": 255, - "name": "params", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "The ID of the system VM instance to diagnose", - "length": 255, - "name": "targetid", - "related": "migrateSystemVm,startSystemVm", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The IP/Domain address to test connection to", - "length": 255, - "name": "ipaddress", - "required": true, + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", - "length": 255, - "name": "type", - "required": true, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the standard error output from the command execution", - "name": "stderr", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "the command execution return code", - "name": "exitcode", + "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" - } - ], - "since": "4.12.0.0" - }, - { - "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", - "isasync": false, - "name": "addNetworkDevice", - "params": [ + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": false, + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, - {}, { - "description": "the ID of the network device", - "name": "id", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" } ] }, { - "description": "Updates a user account", - "isasync": false, - "name": "updateUser", + "description": "Creates a load balancer health check policy", + "isasync": true, + "name": "createLBHealthCheckPolicy", "params": [ { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "mandate2fa", + "name": "intervaltime", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "integer" }, { - "description": "Unique username", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "username", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "password", + "name": "description", "required": false, "type": "string" }, { - "description": "email", + "description": "the ID of the load balancer rule", "length": 255, - "name": "email", + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "length": 255, + "name": "unhealthythreshold", "required": false, - "type": "string" + "type": "integer" }, { - "description": "last name", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "lastname", + "name": "responsetimeout", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "timezone", + "name": "healthythreshold", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "HTTP ping path", "length": 255, - "name": "userapikey", + "name": "pingpath", "required": false, "type": "string" + } + ], + "related": "listLBHealthCheckPolicies", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "User uuid", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", - "required": true, - "type": "uuid" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" }, + {}, { - "description": "The secret key for the user. Must be specified with userApiKey", - "length": 255, - "name": "usersecretkey", - "required": false, + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", - "length": 255, - "name": "currentpassword", - "required": false, + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { - "description": "first name", - "length": 255, - "name": "firstname", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + { + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", + "response": [ + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" + }, + { + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" } ], - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "since": "4.2.0" + }, + { + "description": "Locks a user account", + "isasync": false, + "name": "lockUser", + "params": [ + { + "description": "Locks user by user ID.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + } + ], + "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", "response": [ { - "description": "the user firstname", - "name": "firstname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "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" }, { - "description": "the user email address", - "name": "email", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -86695,880 +88390,834 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, - {}, { "description": "true if user is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, {}, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "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 domain ID of the user", - "name": "domainid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, + {}, { - "description": "the user ID", - "name": "id", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Checks if the Cloudian Connector is enabled", + "isasync": false, + "name": "cloudianIsEnabled", + "params": [], + "related": "", + "response": [ + { + "description": "the Cloudian connector enabled state", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the 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" + }, + {} + ], + "since": "4.11.0" }, { - "description": "Restarts a VPC", - "isasync": true, - "name": "restartVPC", + "description": "Lists load balancer health check policies.", + "isasync": false, + "name": "listLBHealthCheckPolicies", "params": [ { - "description": "the id of the VPC", + "description": "", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Turn a single VPC into a redundant one.", + "description": "the ID of the load balancer rule", "length": 255, - "name": "makeredundant", + "name": "lbruleid", + "related": "updateIpv6FirewallRule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If cleanup old network elements", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "cleanup", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "", "length": 255, - "name": "livepatch", + "name": "page", "required": false, - "since": "4.17.0", - "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", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ] - }, - { - "description": "cleanup simulator mock", - "isasync": false, - "name": "cleanupSimulatorMock", - "params": [ - { - "description": "id of the configured mock", + "description": "the ID of the health check policy", "length": 255, "name": "id", + "related": "listLBHealthCheckPolicies", "required": false, - "type": "long" + "since": "4.4", + "type": "uuid" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, - {}, - {} - ] - }, - { - "description": "Removes a certificate from a load balancer rule", - "isasync": true, - "name": "removeCertFromLoadBalancer", - "params": [ - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" - } - ], - "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", + "response": [ + { + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" + }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + } + ], + "type": "list" + }, + {}, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {} - ] + } + ], + "since": "4.2.0" }, { - "description": "Adds a new host.", + "description": "Creates a network", "isasync": false, - "name": "addHost", + "name": "createNetwork", "params": [ { - "description": "the cluster name for the host", + "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", "length": 255, - "name": "clustername", + "name": "acltype", "required": false, "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "hosttags", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the host URL", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "url", - "required": true, + "name": "routerip", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "the Pod ID for the host", + "description": "the display text of the network", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "displaytext", + "required": false, + "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "ID of the network in an external system.", "length": 255, - "name": "password", + "name": "externalid", "required": false, "type": "string" }, { - "description": "the cluster ID for the host", + "description": "the ID or VID of the network", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the host", + "description": "the network offering ID", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "networkofferingid", + "related": "listNetworkOfferings", "required": true, "type": "uuid" }, { - "description": "hypervisor type of the host", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "hypervisor", - "required": true, + "name": "dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "allocationstate", + "name": "tungstenvirtualrouteruuid", "required": false, "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "username", + "name": "publicmtu", "required": false, - "type": "string" - } - ], - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "response": [ + "since": "4.18.0", + "type": "integer" + }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the gateway of the IPv6 network. Required for Shared networks", + "length": 255, + "name": "ip6gateway", + "required": false, + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "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 amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the first IPv6 DNS for the network", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "Network ACL ID associated for the network", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the first IPv4 DNS for the network", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "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 last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "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 CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "length": 255, + "name": "endip", + "required": false, + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the physical network ID the network belongs to", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the name of the host", + "description": "the name of the network", + "length": 255, "name": "name", + "required": true, "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "IPV6 address to be assigned to a router in a shared network", + "length": 255, + "name": "routeripv6", + "required": false, + "since": "4.16", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the zone ID for the network", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "network domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the isolated private VLAN type for this network", + "length": 255, + "name": "isolatedpvlantype", + "required": false, "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "Account that will own the network. Account should be under the selected domain", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "length": 255, + "name": "subdomainaccess", + "required": false, "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the second IPv6 DNS for the network", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "MTU to be configured on the network VR's private interface(s)", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "an optional project for the network", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the isolated private VLAN for this network", + "length": 255, + "name": "isolatedpvlan", + "required": false, "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the beginning IP address in the network IP range", + "length": 255, + "name": "startip", + "required": false, "type": "string" - }, + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "state of the network", + "name": "state", "type": "string" }, { - "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "events available for the host", - "name": "events", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the host version", - "name": "version", + "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 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 host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - {}, - { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "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 amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" - } - ] - }, - { - "description": "Attaches a disk volume to a virtual machine.", - "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, - "name": "id", - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", - "length": 255, - "name": "deviceid", - "required": false, - "type": "long" - } - ], - "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "ID of the disk volume", + "description": "the id of the network", "name": "id", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -87582,18 +89231,23 @@ "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" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -87607,776 +89261,607 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "set" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "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" + "type": "list" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, - {}, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", + "description": "the domain id of the network owner", "name": "domainid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "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": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - } - ] - }, - { - "description": "adds a baremetal dhcp server", - "isasync": true, - "name": "addBaremetalDhcp", - "params": [ - { - "description": "Credentials to reach external dhcp device", - "length": 255, - "name": "username", - "required": true, + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Type of dhcp device", - "length": 255, - "name": "dhcpservertype", - "required": true, + "description": "the network's gateway", + "name": "gateway", "type": "string" }, + {}, { - "description": "URL of the external dhcp appliance.", - "length": 255, - "name": "url", - "required": true, + "description": "the project name of the address", + "name": "project", "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, - "name": "password", - "required": true, - "type": "string" - } - ], - "related": "listBaremetalDhcp", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "device id of ", - "name": "id", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, - {}, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "url", - "name": "url", - "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": "name of the provider", - "name": "provider", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "name of the provider", - "name": "dhcpservertype", - "type": "string" - } - ] - }, - { - "description": "delete Tungsten-Fabric application policy set", - "isasync": true, - "name": "deleteTungstenFabricApplicationPolicySet", - "params": [ + "description": "the details of the network", + "name": "details", + "type": "map" + }, { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": true, + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", + "description": "the displaytext of the network", "name": "displaytext", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Adds Traffic Monitor Host for Direct Network Usage", + "description": "Lists all available network offerings.", "isasync": false, - "name": "addTrafficMonitor", + "name": "listNetworkOfferings", "params": [ { - "description": "Traffic going into the listed zones will not be metered", + "description": "list by traffic type", "length": 255, - "name": "excludezones", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "Zone in which to add the external firewall appliance.", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "sourcenatsupported", + "required": false, + "type": "boolean" }, { - "description": "Traffic going into the listed zones will be metered", + "description": "List by keyword", "length": 255, - "name": "includezones", + "name": "keyword", "required": false, "type": "string" }, { - "description": "URL of the traffic monitor Host", + "description": "list network offerings by state", "length": 255, - "name": "url", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "name": "state", + "required": false, "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "list network offerings by guest type: shared or isolated", + "length": 255, + "name": "guestiptype", + "required": false, "type": "string" }, { - "description": "the zone ID of the external firewall", + "description": "list network offerings available for network creation in specific zone", + "length": 255, "name": "zoneid", - "type": "string" + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list network offerings available for network creation in specific domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "since": "4.13", + "type": "uuid" }, - {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" + "description": "true if offering has tags specified", + "length": 255, + "name": "istagged", + "required": false, + "type": "boolean" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", + "required": false, "type": "string" - } - ] - }, - { - "description": "Updates a project", - "isasync": true, - "name": "updateProject", - "params": [ + }, { - "description": "display text of the project", + "description": "list network offerings by display text", "length": 255, "name": "displaytext", "required": false, "type": "string" }, { - "description": "id of the project to be modified", + "description": "list network offerings by ID", "length": 255, "name": "id", - "related": "activateProject,suspendProject,updateProject", - "required": true, + "related": "listNetworkOfferings", + "required": false, "type": "uuid" }, { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "swapowner", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "ID of the user to be promoted/demoted", + "description": "list network offerings by name", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "list network offerings supporting certain services", "length": 255, - "name": "roletype", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "name of the project", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "name", + "name": "availability", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "new Admin account for the project", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "account", + "name": "specifyipranges", "required": false, - "type": "string" - } - ], - "related": "activateProject,suspendProject", - "response": [ - { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - {}, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the tags for the network offering.", + "length": 255, + "name": "specifyvlan", + "required": false, + "type": "boolean" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "true if need to list only default network offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "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 total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of vpcs the project 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 vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, + {}, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the state of the project", - "name": "state", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the list of resource tags associated with vm", + "description": "the tags for the network offering", "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the id of the project", - "name": "id", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists internal load balancers", + "description": "Lists dedicated pods.", "isasync": false, - "name": "listLoadBalancers", + "name": "listDedicatedPods", "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -88385,590 +89870,969 @@ "type": "integer" }, { - "description": "the network ID of the source IP address", + "description": "the ID of the domain associated with the pod", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "the source IP address of the load balancer", + "description": "", "length": 255, - "name": "sourceipaddress", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the pod", "length": 255, - "name": "isrecursive", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the load balancer", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the network ID of the load balancer", + "description": "list dedicated pods by affinity group", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "affinitygroupid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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 Pod", + "name": "podname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the Pod", + "name": "podid", + "type": "string" + }, + { + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", + "type": "string" + }, + {}, + {}, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Attempts Migration of a VM with its volumes to a different host", + "isasync": true, + "name": "migrateVirtualMachineWithVolume", + "params": [ + { + "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", "length": 255, - "name": "listall", + "name": "migrateto", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "the ID of the virtual machine", "length": 255, - "name": "scheme", - "required": false, - "type": "string" + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the name of the load balancer", + "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", "length": 255, - "name": "name", + "name": "autoselect", "required": false, - "type": "string" + "since": "4.19.0", + "type": "boolean" } ], - "related": "createLoadBalancer", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the name of the instance", - "name": "name", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the instance ID", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - } - ], - "type": "list" - }, - {}, - {}, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" } ], - "type": "list" + "type": "set" }, + {}, { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists user accounts", - "isasync": false, - "name": "listUsers", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "List user by ID.", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "required": false, - "type": "uuid" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "flag to display the resource icon for users", - "length": 255, - "name": "showicon", - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "List user by the username", - "length": 255, - "name": "username", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "List users by state of the user account.", - "length": 255, - "name": "state", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "List 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 only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "createUser,disableUser,enableUser,getUser", - "response": [ - { - "description": "the api key of the user", - "name": "apikey", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + {}, { - "description": "the user firstname", - "name": "firstname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user name", + "description": "the user's name who deployed the virtual machine", "name": "username", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the user ID", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, - {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, + {}, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the type of the role", - "name": "roletype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" - } - ] - }, - { - "description": "This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user", - "isasync": false, - "name": "registerUserKeys", - "params": [ - { - "description": "User id", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "the api key of the registered user", - "name": "apikey", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Deletes a load balancer stickiness policy.", - "isasync": true, - "name": "deleteLBStickinessPolicy", - "params": [ - { - "description": "the ID of the LB stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -88976,240 +90840,254 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Updates a VLAN IP range.", - "isasync": false, - "name": "updateVlanIpRange", - "params": [ { - "description": "the beginning IP address in the VLAN IP range", - "length": 255, - "name": "startip", - "required": false, + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the UUID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange,dedicatePublicIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the gateway of the IPv6 network", - "length": 255, - "name": "ip6gateway", - "required": false, + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", - "length": 255, - "name": "netmask", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "length": 255, - "name": "gateway", - "required": false, - "type": "string" - } - ], - "related": "dedicatePublicIpRange", - "response": [ - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "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 end ip of the VLAN IP range", - "name": "endip", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" - }, + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + } + ] + }, + { + "description": "Lists VPCs", + "isasync": false, + "name": "listVPCs", + "params": [ { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "List by display text of the VPC", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "list VPCs by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, - {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "flag to display the resource icon for VPCs", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "list VPC by id", + "length": 255, + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - } - ], - "since": "4.16.0" - }, - { - "description": "Lists site to site vpn connection gateways", - "isasync": false, - "name": "listVpnConnections", - "params": [ - { - "description": "id of vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -89220,48 +91098,49 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "account", + "name": "cidr", "required": false, "type": "string" }, { - "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": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 zone", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -89270,258 +91149,427 @@ "required": false, "type": "boolean" }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list VPC supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "id of the vpn connection", + "description": "list by name of the VPC", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections", + "name": "name", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "list VPCs by restartRequired option", + "length": 255, + "name": "restartrequired", + "required": false, + "type": "boolean" } ], - "related": "createVpnConnection", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the owner of the VPC", + "name": "account", "type": "string" }, - {}, { "description": "the domain name of the owner", "name": "domain", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the VPC", + "name": "name", + "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the domain id of the owner", + "description": "the domain id of the VPC owner", "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "the project name", - "name": "project", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the project name of the VPC", + "name": "project", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "the date this VPC 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", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag 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 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" + } + ], + "type": "list" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, - {}, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, { - "description": "Lists resource limits.", + "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", "isasync": false, - "name": "listResourceLimits", + "name": "addNetworkDevice", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "parameters for network device", "length": 255, - "name": "account", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "networkdevicetype", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetypename", - "required": false, + "description": "the ID of the network device", + "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", + "isasync": true, + "name": "runDiagnostics", + "params": [ { - "description": "Lists resource limits by ID.", + "description": "The IP/Domain address to test connection to", "length": 255, - "name": "id", - "required": false, - "type": "long" + "name": "ipaddress", + "required": true, + "type": "string" }, { - "description": "", + "description": "Additional command line options that apply for each command", "length": 255, - "name": "pagesize", + "name": "params", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "The ID of the system VM instance to diagnose", "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" + "name": "targetid", + "related": "migrateSystemVm,startSystemVm", + "required": true, + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "type", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the standard output from the command execution", + "name": "stdout", "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 command execution return code", + "name": "exitcode", "type": "string" }, { @@ -89529,76 +91577,127 @@ "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 project id of the resource limit", - "name": "projectid", + "description": "the standard error output from the command execution", + "name": "stderr", + "type": "string" + } + ], + "since": "4.12.0.0" + }, + { + "description": "Updates a user account", + "isasync": false, + "name": "updateUser", + "params": [ + { + "description": "Unique username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", + "description": "last name", + "length": 255, + "name": "lastname", + "required": false, "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "The secret key for the user. Must be specified with userApiKey", + "length": 255, + "name": "usersecretkey", + "required": false, "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "first name", + "length": 255, + "name": "firstname", + "required": false, "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "The API key for the user. Must be specified with userSecretKey", + "length": 255, + "name": "userapikey", + "required": false, "type": "string" - } - ] - }, - { - "description": "Disables a user account", - "isasync": true, - "name": "disableUser", - "params": [ + }, { - "description": "Disables user by user ID.", + "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "length": 255, + "name": "mandate2fa", + "required": false, + "since": "4.18.0.0", + "type": "boolean" + }, + { + "description": "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": "email", + "length": 255, + "name": "email", + "required": false, + "type": "string" + }, + { + "description": "User uuid", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser", + "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", "required": true, "type": "uuid" + }, + { + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "length": 255, + "name": "currentpassword", + "required": false, + "type": "string" } ], - "related": "createUser,enableUser,getUser", + "related": "createUser,disableUser,enableUser,getUser,listUsers", "response": [ { - "description": "the domain name of the user", - "name": "domain", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "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 name", - "name": "username", - "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 api key of the user", @@ -89606,19 +91705,33 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -89626,15 +91739,16 @@ "name": "firstname", "type": "string" }, + {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user state", + "name": "state", "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": "true if user has two factor authentication enabled", @@ -89647,24 +91761,25 @@ "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user name", + "name": "username", "type": "string" }, + {}, { "description": "the name of the role", "name": "rolename", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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", @@ -89672,38 +91787,18 @@ "type": "string" }, { - "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 user email address", - "name": "email", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", + "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": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -89712,612 +91807,616 @@ "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" } ] }, { - "description": "remove Tungsten-Fabric policy", + "description": "Restarts a VPC", "isasync": true, - "name": "removeTungstenFabricPolicy", + "name": "restartVPC", "params": [ { - "description": "the uuid of Tungsten-Fabric policy", + "description": "If cleanup old network elements", "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" + "name": "cleanup", + "required": false, + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" }, { - "description": "the ID of zone", + "description": "Turn a single VPC into a redundant one.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "makeredundant", + "required": false, + "type": "boolean" + }, + { + "description": "the id of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", "required": true, "type": "uuid" } ], - "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy", "response": [ - { - "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 provider zone id", - "name": "zoneid", - "type": "long" - }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" } ] }, { - "description": "Lists all available ISO files.", - "isasync": false, - "name": "listIsos", + "description": "Removes a certificate from a load balancer rule", + "isasync": true, + "name": "removeCertFromLoadBalancer", "params": [ { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "the ID of the load balancer rule", "length": 255, - "name": "ispublic", - "required": false, + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list all ISOs by name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Adds a new host.", + "isasync": false, + "name": "addHost", + "params": [ + { + "description": "hypervisor type of the host", "length": 255, - "name": "name", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "If set to true, list only unique isos across zones", + "description": "the cluster name for the host", "length": 255, - "name": "showunique", + "name": "clustername", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the cluster ID for the host", "length": 255, - "name": "account", + "name": "clusterid", + "related": "addCluster", "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": "the host URL", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "url", + "required": true, + "type": "string" }, { - "description": "list ISO by ID", + "description": "list of tags to be added to the host", "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "hosttags", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the ID of the zone", + "description": "the Pod ID for the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "isofilter", + "name": "password", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "keyword", + "name": "username", "required": false, "type": "string" }, { - "description": "", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "pagesize", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the Zone ID for the host", "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "response": [ { - "description": "show removed ISOs as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "flag to display the resource image for the isos", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this ISO is ready to be deployed", - "length": 255, - "name": "isready", - "required": false, + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - } - ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "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 host", + "name": "name", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if this 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 project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "Host details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the host version", + "name": "version", "type": "string" }, + {}, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the date this template was created", - "name": "created", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, - {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "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 ID of the host", + "name": "id", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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 state of the host", + "name": "state", + "type": "status" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "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 this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" } ] }, { - "description": "Migrate current NFS secondary storages to use object store.", - "isasync": false, - "name": "updateCloudToUseObjectStore", + "description": "Attaches a disk volume to a virtual machine.", + "isasync": true, + "name": "attachVolume", "params": [ { - "description": "the URL for the image store", + "description": "the ID of the disk volume", "length": 255, - "name": "url", - "required": false, - "type": "string" + "name": "id", + "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" }, { - "description": "the name for the image store", + "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", "length": 255, - "name": "name", + "name": "deviceid", "required": false, - "type": "string" + "type": "long" }, { - "description": "the image store provider name", + "description": " the ID of the virtual machine", "length": 255, - "name": "provider", + "name": "virtualmachineid", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, - "type": "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" + "type": "uuid" } ], - "related": "listSwifts,addImageStoreS3,listImageStores", + "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -90325,826 +92424,699 @@ "type": "integer" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, { - "description": "the name of the image store", - "name": "name", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" - } - ], - "since": "4.3.0" - }, - { - "description": "Lists autoscale policies.", - "isasync": false, - "name": "listAutoScalePolicies", - "params": [ - { - "description": "the ID of the autoscale vm group", - "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the condition of the policy", - "length": 255, - "name": "conditionid", - "related": "", - "required": false, - "type": "uuid" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "length": 255, - "name": "action", - "required": false, + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, + {}, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + {}, { - "description": "the autoscale policy ID", - "name": "id", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, - {}, - {}, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "pod id of the volume", + "name": "podid", "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": "adds baremetal rack configuration text", - "isasync": true, - "name": "addBaremetalRct", - "params": [ - { - "description": "http url to baremetal RCT configuration", - "length": 255, - "name": "baremetalrcturl", - "required": true, - "type": "object" - } - ], - "related": "", - "response": [ + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { - "description": "id of rct", - "name": "id", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "url", - "name": "url", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, - {}, - {} - ] - }, - { - "description": "add Tungsten-Fabric network gateway to logical router", - "isasync": true, - "name": "addTungstenFabricNetworkGatewayToLogicalRouter", - "params": [ { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "Tungsten-Fabric network uuid", - "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "Tungsten-Fabric logical router uuid", - "length": 255, - "name": "logicalrouteruuid", - "required": true, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" - } - ], - "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ + }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "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", - "name": "jobstatus", - "type": "integer" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - {}, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - } - ] - }, - { - "description": "Updates a role", - "isasync": false, - "name": "updateRole", - "params": [ { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", - "length": 255, - "name": "type", - "required": false, + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "creates a role with this unique name", - "length": 255, - "name": "name", - "required": false, + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" - } - ], - "related": "importRole,listRoles", - "response": [ + }, { - "description": "the ID of the role", - "name": "id", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, - {}, { - "description": "the type of the role", - "name": "type", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, - {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" - } - ], - "since": "4.9.0" - }, - { - "description": "list Tungsten-Fabric nic", - "isasync": false, - "name": "listTungstenFabricNic", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the uuid of Tungsten-Fabric nic", - "length": 255, - "name": "nicuuid", - "required": false, - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "Tungsten-Fabric nic name", - "name": "name", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" } ] }, { - "description": "apply Tungsten-Fabric policy", + "description": "adds a baremetal dhcp server", "isasync": true, - "name": "applyTungstenFabricPolicy", + "name": "addBaremetalDhcp", "params": [ { - "description": "the ID of zone", + "description": "the Physical Network ID", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, "type": "uuid" }, { - "description": "the major sequence of Tungsten-Fabric policy", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "majorsequence", + "name": "password", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the minor sequence of Tungsten-Fabric policy", + "description": "Type of dhcp device", "length": 255, - "name": "minorsequence", + "name": "dhcpservertype", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "policyuuid", + "name": "username", "required": true, "type": "string" }, { - "description": "the uuid of network", + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "networkuuid", + "name": "url", "required": true, "type": "string" } ], - "related": "listTungstenFabricPolicy", + "related": "listBaremetalDhcp", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "name of the provider", + "name": "dhcpservertype", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "url", + "name": "url", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "device id of ", + "name": "id", + "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "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": "Lists zones", - "isasync": false, - "name": "listZones", + "description": "delete Tungsten-Fabric application policy set", + "isasync": true, + "name": "deleteTungstenFabricApplicationPolicySet", "params": [ { - "description": "the name of the zone", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "name", - "required": false, + "name": "applicationpolicysetuuid", + "required": true, "type": "string" }, { - "description": "the ID of the domain associated with the zone", + "description": "the ID of zone", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, "type": "uuid" - }, - { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", - "length": 255, - "name": "available", - "required": false, - "type": "boolean" - }, + } + ], + "response": [ { - "description": "the network type of the zone that the virtual machine belongs to", - "length": 255, - "name": "networktype", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "flag to display the resource image for the zones", - "length": 255, - "name": "showicon", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "List zones by resource tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "since": "4.3", - "type": "map" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {} + ] + }, + { + "description": "Copies a snapshot from one zone to another.", + "isasync": true, + "name": "copySnapshot", + "params": [ { - "description": "", + "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", "length": 255, - "name": "pagesize", + "name": "destzoneids", + "related": "createZone,listZones,listZones", "required": false, - "type": "integer" + "type": "list" }, { - "description": "flag to display the capacity of the zones", + "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", "length": 255, - "name": "showcapacities", + "name": "sourcezoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the ID of the snapshot.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "copySnapshot,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" }, { - "description": "the ID of the zone", + "description": "The ID of the zone the snapshot is being copied to.", "length": 255, - "name": "id", + "name": "destzoneid", "related": "createZone,listZones,listZones", "required": false, "type": "uuid" } ], - "related": "createZone,listZones", + "related": "revertSnapshot,listSnapshots", "response": [ { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, - {}, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, + {}, { - "description": "Zone name", - "name": "name", + "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + {}, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "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": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, - {}, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the list of resource tags associated with zone.", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -91153,13 +93125,13 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -91168,787 +93140,738 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds Traffic Monitor Host for Direct Network Usage", + "isasync": false, + "name": "addTrafficMonitor", + "params": [ + { + "description": "Traffic going into the listed zones will be metered", + "length": 255, + "name": "includezones", + "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Zone in which to add the external firewall appliance.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "URL of the traffic monitor Host", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - } - ], - "type": "list" - } - ] - }, - { - "description": "Lists remote access vpns", - "isasync": false, - "name": "listRemoteAccessVpns", - "params": [ - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Traffic going into the listed zones will not be metered", "length": 255, - "name": "fordisplay", + "name": "excludezones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" }, + {}, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the ID of the external firewall", + "name": "id", + "type": "string" }, { - "description": "public ip address id of the vpn server", - "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "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 only resources belonging to the domain specified", + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" + }, + {} + ] + }, + { + "description": "Updates a project", + "isasync": true, + "name": "updateProject", + "params": [ + { + "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "swapowner", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "new Admin account for the project", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "display text of the project", "length": 255, - "name": "isrecursive", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "ID of the user to be promoted/demoted", "length": 255, - "name": "pagesize", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of the project to be modified", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "id", + "related": "activateProject,suspendProject,updateProject", + "required": true, "type": "uuid" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "name of the project", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "name": "name", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "list remote access VPNs for certain network", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "roletype", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" } ], - "related": "updateRemoteAccessVpn", + "related": "activateProject,suspendProject", "response": [ - {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the id of the remote access vpn", + "description": "the id of the project", "name": "id", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, + {}, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes the backup schedule of a VM", - "isasync": false, - "name": "deleteBackupSchedule", - "params": [ - { - "description": "ID of the VM", - "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" - } - ], - "response": [ + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "Deletes a network ACL", - "isasync": true, - "name": "deleteNetworkACLList", - "params": [ + }, { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the state of the project", + "name": "state", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Removes secondary IP from the NIC.", - "isasync": true, - "name": "removeIpFromNic", - "params": [ { - "description": "the ID of the secondary ip address to nic", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the date this project was created", + "name": "created", + "type": "date" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" - } - ] - }, - { - "description": "Creates a system virtual-machine that implements network services", - "isasync": true, - "name": "createServiceInstance", - "params": [ - { - "description": "The right (outside) network ID for the service instance", - "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" }, { - "description": "An optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "The left (inside) network for service instance", - "length": 255, - "name": "leftnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "The name of the service instance", - "length": 255, - "name": "name", - "required": true, + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "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 displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "Project ID for the service instance", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "The service offering ID that defines the resources consumed by the service appliance", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "Availability zone for the service instance", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "The template ID that specifies the image for the service appliance", - "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the project name of the vm", - "name": "project", + "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", "name": "jobid", "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 total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, - {} - ] + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + } + ], + "since": "3.0.0" }, { - "description": "Lists external backup offerings of the provider", + "description": "Lists internal load balancers", "isasync": false, - "name": "listBackupProviderOfferings", + "name": "listLoadBalancers", "params": [ { - "description": "", + "description": "the network ID of the source IP address", "length": 255, - "name": "page", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The zone ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, "type": "uuid" }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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" - } - ], - "related": "importBackupOffering", - "response": [ - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "zone ID", - "name": "zoneid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", + "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 for the backup offering", - "name": "description", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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": "zone name", - "name": "zonename", + "description": "the source IP address of the load balancer", + "length": 255, + "name": "sourceipaddress", + "required": false, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "name for the backup offering", + "description": "the name of the load balancer", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "ID of the backup offering", + "description": "the ID of the load balancer", + "length": 255, "name": "id", + "related": "updateIpv6FirewallRule", + "required": false, + "type": "uuid" + }, + { + "description": "the scheme of the load balancer. Supported value is internal in the current release", + "length": 255, + "name": "scheme", + "required": false, "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "Releases a Public IP range back to the system pool", - "isasync": false, - "name": "releasePublicIpRange", - "params": [ + }, { - "description": "the id of the Public IP range", + "description": "the network ID of the load balancer", "length": 255, - "name": "id", - "related": "dedicatePublicIpRange", - "required": true, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" } ], + "related": "createLoadBalancer", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "lists network that are using a netscaler load balancer device", - "isasync": false, - "name": "listNetscalerLoadBalancerNetworks", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", - "required": true, - "type": "uuid" + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "response": [ - {}, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "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": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "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 routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "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 list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -91956,11 +93879,6 @@ "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", @@ -91972,8 +93890,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -91982,876 +93900,814 @@ "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 key name", - "name": "key", + "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" } ], "type": "list" + } + ], + "since": "4.2.0" + }, + { + "description": "Lists user accounts", + "isasync": false, + "name": "listUsers", + "params": [ + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "List user by the username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "List user by ID.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "List users by state of the user account.", + "length": 255, + "name": "state", + "required": false, + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "flag to display the resource icon for users", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" - }, + } + ], + "related": "createUser,disableUser,enableUser,getUser", + "response": [ { - "description": "the type of the network", - "name": "type", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "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": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user state", + "name": "state", "type": "string" }, + {}, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, + {}, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "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 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 user account was created", + "name": "created", + "type": "date" }, { - "description": "the owner of the network", - "name": "account", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the type of the role", + "name": "roletype", "type": "string" }, - {}, { - "description": "related to what other network configuration", - "name": "related", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "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": "VPC the network belongs to", - "name": "vpcid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" } ] }, { - "description": "create Tungsten-Fabric public network", + "description": "This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user", "isasync": false, - "name": "createTungstenFabricPublicNetwork", + "name": "registerUserKeys", "params": [ { - "description": "the ID of zone", + "description": "User id", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "createUser,disableUser,enableUser,getUser", "required": true, "type": "uuid" } ], + "related": "", "response": [ + {}, + {}, + { + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { - "description": "Starts a system virtual machine.", + "description": "Deletes a load balancer stickiness policy.", "isasync": true, - "name": "startSystemVm", + "name": "deleteLBStickinessPolicy", "params": [ { - "description": "The ID of the system virtual machine", + "description": "the ID of the LB stickiness policy", "length": 255, "name": "id", - "related": "migrateSystemVm,startSystemVm", + "related": "createLBStickinessPolicy,listLBStickinessPolicies", "required": true, "type": "uuid" } ], - "related": "migrateSystemVm", "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 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 link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Updates a VLAN IP range.", + "isasync": false, + "name": "updateVlanIpRange", + "params": [ { - "description": "the 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 of the IPv6 network", + "length": 255, + "name": "ip6gateway", + "required": false, "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "true if IP range is set to system vms, false if not", + "length": 255, + "name": "forsystemvms", + "required": false, + "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the UUID of the VLAN IP range", + "length": 255, + "name": "id", + "related": "updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" }, - {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", + "required": false, "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ending IP address in the VLAN IP range", + "length": 255, + "name": "endip", + "required": false, + "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, "type": "string" - }, + } + ], + "related": "dedicatePublicIpRange", + "response": [ { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, + {}, { - "description": "the state of the system VM", - "name": "state", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.16.0" }, { - "description": "Lists host HA resources", + "description": "Lists site to site vpn connection gateways", "isasync": false, - "name": "listHostHAResources", + "name": "listVpnConnections", "params": [ { - "description": "List by host ID", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "keyword", "required": false, - "type": "uuid" - } - ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "id of the vpn connection", + "length": 255, + "name": "id", + "related": "createVpnConnection,listVpnConnections", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "operation status", - "name": "status", + "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 HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Lists supported methods of network isolation", - "isasync": false, - "name": "listNetworkIsolationMethods", - "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", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "id of vpc", "length": 255, - "name": "page", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "", + "related": "createVpnConnection", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Network isolation method name", - "name": "name", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "state", "type": "string" }, {}, - {} - ], - "since": "4.2.0" - }, - { - "description": "Lists VM stats", - "isasync": false, - "name": "listVirtualMachinesUsageHistory", - "params": [ { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "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, + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the ID of the virtual machine.", - "length": 255, - "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, + {}, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listSystemVmsUsageHistory", - "response": [ - {}, + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the public IP address", + "name": "publicip", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", + "description": "the connection ID", "name": "id", "type": "string" }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, { "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", + "type": "string" + }, + { + "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": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" } - ], - "since": "4.17" + ] }, { - "description": "list Tungsten-Fabric firewall policy", + "description": "Lists resource limits.", "isasync": false, - "name": "listTungstenFabricFirewallPolicy", + "name": "listResourceLimits", "params": [ { - "description": "the ID of zone", + "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": "zoneid", - "related": "createZone,listZones", + "name": "resourcetypename", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "applicationpolicysetuuid", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" + }, + { + "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": "List by keyword", @@ -92868,228 +94724,226 @@ "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": "the uuid of Tungsten-Fabric firewall policy", + "description": "Lists resource limits by ID.", "length": 255, - "name": "firewallpolicyuuid", + "name": "id", + "required": false, + "type": "long" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" + }, + { + "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" + }, + { + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", "type": "long" }, - {}, { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" + "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": "Tungsten-Fabric provider zone name", - "name": "zonename", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the resource limit", + "name": "domain", + "type": "string" }, - {} + { + "description": "the project name of the resource limit", + "name": "project", + "type": "string" + } ] }, { - "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", + "description": "Disables a user account", "isasync": true, - "name": "declareHostAsDegraded", + "name": "disableUser", "params": [ { - "description": "host ID", + "description": "Disables user by user ID.", "length": 255, "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "createUser,disableUser,enableUser,getUser", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "related": "createUser,enableUser,getUser", "response": [ { - "description": "the admin that annotated this host", - "name": "username", - "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": "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 date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the user lastname", + "name": "lastname", + "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 user", + "name": "domain", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, {}, { - "description": "events available for the host", - "name": "events", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -93097,1308 +94951,1573 @@ "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the user email address", + "name": "email", "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 account name of the user", + "name": "account", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicy", + "params": [ { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, + } + ], + "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy", + "response": [ { - "description": "the host version", - "name": "version", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, + {}, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the name of the host", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the host", + "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {}, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Lists all available ISO files.", + "isasync": false, + "name": "listIsos", + "params": [ { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - } - ], - "since": "4.16.0.0" - }, - { - "description": "Creates a Kubernetes cluster", - "isasync": true, - "name": "createKubernetesCluster", - "params": [ - { - "description": "password for the docker image private registry", + "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": "dockerregistrypassword", + "name": "isofilter", "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "", "length": 255, - "name": "controlnodes", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "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": "Network in which Kubernetes cluster is to be launched", + "description": "true if the ISO is bootable, false otherwise", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "bootable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "showunique", "required": false, - "type": "string" + "since": "4.13.2", + "type": "boolean" }, { - "description": "root disk size in GB for each node", + "description": "", "length": 255, - "name": "noderootdisksize", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "description for the Kubernetes cluster", + "description": "ID of the storage pool", "length": 255, - "name": "description", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "true if this ISO is ready to be deployed", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "isready", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "show removed ISOs as well", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "URL for the docker image private registry", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "dockerregistryurl", + "name": "account", "required": false, "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "keypair", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "size", + "name": "tags", "required": false, - "type": "long" + "type": "map" }, { - "description": "Deploy cluster for the project", + "description": "the ID of the zone", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "user name for the docker image private registry", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "dockerregistryusername", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "name for the Kubernetes cluster", + "description": "ID of the image or image cache store", + "length": 255, + "name": "imagestoreid", + "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "list all ISOs by name", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "masternodes", + "name": "ispublic", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "clustertype", - "required": true, - "since": "4.19.0", + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "list ISO by ID", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "id", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" } ], - "related": "startKubernetesCluster", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "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 date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the account id to which the template belongs", + "name": "accountid", "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": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, - {}, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the Kubernetes cluster", + "description": "the template name", "name": "name", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "List a storage network IP range.", - "isasync": false, - "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.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", - "required": false, - "type": "uuid" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, + {}, + {}, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createStorageNetworkIpRange", - "response": [ - {}, + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "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": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Imports a backup offering using a backup provider", - "isasync": true, - "name": "importBackupOffering", + "description": "Migrate current NFS secondary storages to use object store.", + "isasync": false, + "name": "updateCloudToUseObjectStore", "params": [ { - "description": "The zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the description of the backup offering", + "description": "the URL for the image store", "length": 255, - "name": "description", - "required": true, + "name": "url", + "required": false, "type": "string" }, { - "description": "Whether users are allowed to create adhoc backups and backup schedules", + "description": "the image store provider name", "length": 255, - "name": "allowuserdrivenbackups", + "name": "provider", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the name of the backup offering", + "description": "the name for the image store", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" }, { - "description": "The backup offering ID (from backup provider side)", + "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": "externalid", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" } ], - "related": "", + "related": "listSwifts,addImageStoreS3,listImageStores", "response": [ - {}, { - "description": "zone name", - "name": "zonename", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone ID", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "name for the backup offering", - "name": "name", + "description": "the ID of the image store", + "name": "id", "type": "string" }, + {}, { - "description": "description for the backup offering", - "name": "description", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "ID of the backup offering", - "name": "id", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" - }, - {} + } ], - "since": "4.14.0" + "since": "4.3.0" }, { - "description": "Enables HA for a host", - "isasync": true, - "name": "enableHAForHost", + "description": "Lists autoscale policies.", + "isasync": false, + "name": "listAutoScalePolicies", "params": [ { - "description": "ID of the host", + "description": "the name of the autoscale policy", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "configureHAForHost,disableHAForHost,listHostHAProviders", - "response": [ + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" + }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "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": "the ID of the condition of the policy", + "length": 255, + "name": "conditionid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the ID of the autoscale vm group", + "length": 255, + "name": "vmgroupid", + "related": "listAutoScaleVmGroups", + "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 ID of the host", - "name": "hostid", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "length": 255, + "name": "action", + "required": false, "type": "string" }, - {} - ], - "since": "4.11" - }, - { - "description": "Deletes a specified domain", - "isasync": true, - "name": "deleteDomain", - "params": [ { - "description": "ID of domain to delete", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "description": "", "length": 255, - "name": "cleanup", + "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" } ], + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the autoscale policy", + "name": "name", + "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + { + "description": "the project id autoscale policy", + "name": "projectid", + "type": "string" + }, + { + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" + }, + { + "description": "the account owning the autoscale policy", + "name": "account", + "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", + "type": "string" } ] }, { - "description": "Configures a virtual router element.", + "description": "adds baremetal rack configuration text", "isasync": true, - "name": "configureVirtualRouterElement", + "name": "addBaremetalRct", "params": [ { - "description": "the ID of the virtual router provider", - "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", - "required": true, - "type": "uuid" - }, - { - "description": "Enabled/Disabled the service provider", + "description": "http url to baremetal RCT configuration", "length": 255, - "name": "enabled", + "name": "baremetalrcturl", "required": true, - "type": "boolean" + "type": "object" } ], - "related": "listVirtualRouterElements", + "related": "", "response": [ { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "id of rct", + "name": "id", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "url", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "add Tungsten-Fabric network gateway to logical router", + "isasync": true, + "name": "addTungstenFabricNetworkGatewayToLogicalRouter", + "params": [ { - "description": "the id of the router", - "name": "id", + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" }, - {}, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "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", - "type": "boolean" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "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" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" } ] }, { - "description": "Migrate volume", - "isasync": true, - "name": "migrateVolume", + "description": "Updates a role", + "isasync": false, + "name": "updateRole", "params": [ { - "description": "if the volume should be live migrated when it is attached to a running vm", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", "length": 255, - "name": "livemigrate", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "destination storage pool ID to migrate the volume to", + "description": "ID of the role", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "id", + "related": "importRole,listRoles,updateRole", "required": true, "type": "uuid" }, { - "description": "the ID of the volume", + "description": "The description of the role", "length": 255, - "name": "volumeid", - "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", + "description": "creates a role with this unique name", "length": 255, - "name": "newdiskofferingid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "importRole,listRoles", "response": [ { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "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": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.9.0" + }, + { + "description": "list Tungsten-Fabric nic", + "isasync": false, + "name": "listTungstenFabricNic", + "params": [ + { + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "Tungsten-Fabric nic name", + "name": "name", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", "type": "string" + } + ] + }, + { + "description": "Retrieves VMware DC(s) associated with a zone.", + "isasync": false, + "name": "listVmwareDcs", + "params": [ + { + "description": "Id of the CloudStack zone.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "addVmwareDc", + "response": [ { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" + } + ] + }, + { + "description": "apply Tungsten-Fabric policy", + "isasync": true, + "name": "applyTungstenFabricPolicy", + "params": [ + { + "description": "the major sequence of Tungsten-Fabric policy", + "length": 255, + "name": "majorsequence", + "required": true, + "type": "integer" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the minor sequence of Tungsten-Fabric policy", + "length": 255, + "name": "minorsequence", + "required": true, + "type": "integer" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" }, - {}, { - "description": "the state of the disk volume", - "name": "state", + "description": "the uuid of network", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" - }, + } + ], + "related": "listTungstenFabricPolicy", + "response": [ + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + } + ] + }, + { + "description": "Lists zones", + "isasync": false, + "name": "listZones", + "params": [ + { + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "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": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "flag to display the resource image for the zones", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the zone", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the ID of the zone", + "length": 255, + "name": "id", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the IDs of the zones, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "list" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createZone,listZones", + "response": [ + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + } + ], + "type": "list" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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 maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -94407,1501 +96526,1455 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "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": "Tungsten-Fabric application policy set name", - "length": 255, - "name": "name", - "required": true, + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, - { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "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 UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" - } - ] - }, - { - "description": "Lists HA providers", - "isasync": false, - "name": "listHostHAProviders", - "params": [ - { - "description": "Hypervisor type of the resource", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - } - ], - "related": "configureHAForHost,disableHAForHost", - "response": [ - { - "description": "the host HA provider", - "name": "haprovider", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, {}, { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" } - ], - "since": "4.11" + ] }, { - "description": "A command to list events.", + "description": "Lists remote access vpns", "isasync": false, - "name": "listEvents", + "name": "listRemoteAccessVpns", "params": [ { - "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": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list remote access VPNs for certain network", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "since": "4.3", + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "enddate", + "name": "fordisplay", "required": false, - "type": "date" + "since": "4.4", + "type": "boolean" }, { - "description": "the event type (see event types)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "type", + "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 objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the time the event was entered", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "entrytime", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "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": "public ip address id of the vpn server", "length": 255, - "name": "startdate", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "date" + "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": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the type of the resource associated with the event", - "length": 255, - "name": "resourcetype", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "the ID of the event", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listEvents", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" - }, + } + ], + "related": "updateRemoteAccessVpn", + "response": [ { - "description": "the event level (INFO, WARN, ERROR)", - "length": 255, - "name": "level", - "required": false, + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the resource associated with the event", - "length": 255, - "name": "resourceid", - "required": false, - "since": "4.17.0", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the duration of the event", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the id of the remote access vpn", + "name": "id", + "type": "string" }, { - "description": "true to list archived events otherwise false", - "length": 255, - "name": "archived", - "required": false, - "since": "4.19.0", - "type": "boolean" - } - ], - "related": "", - "response": [ + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", + "description": "the account of the remote access vpn", "name": "account", "type": "string" }, + {}, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the id of the resource", - "name": "resourceid", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the name of the resource", - "name": "resourcename", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the event", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + } + ] + }, + { + "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", + "isasync": false, + "name": "removeQuarantinedIp", + "params": [ + { + "description": "The reason for removing the public IP address from quarantine prematurely.", + "length": 255, + "name": "removalreason", + "required": true, + "type": "string" + }, + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "id", + "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "required": false, + "type": "uuid" + } + ], + "related": "listQuarantinedIps,updateQuarantinedIp", + "response": [ + { + "description": "ID of the quarantine process.", "name": "id", "type": "string" }, { - "description": "the type of the event (see event types)", - "name": "type", + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the date the event was created", - "name": "created", + "description": "End date for the quarantine.", + "name": "enddate", "type": "date" }, { - "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", - "name": "username", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { - "description": "a brief description of the event", - "name": "description", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "whether the event has been archived or not", - "name": "archived", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" + }, + {}, + { + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + } + ], + "since": "4.19" + }, + { + "description": "Deletes a network ACL", + "isasync": true, + "name": "deleteNetworkACLList", + "params": [ + { + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACLList", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the name of the account's domain", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the event", - "name": "state", - "type": "state" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Removes secondary IP from the NIC.", + "isasync": true, + "name": "removeIpFromNic", + "params": [ + { + "description": "the ID of the secondary ip address to nic", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { - "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", + "description": "Creates a system virtual-machine that implements network services", "isasync": true, - "name": "updateVMAffinityGroup", + "name": "createServiceInstance", "params": [ { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "The name of the service instance", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Availability zone for the service instance", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "The ID of the virtual machine", + "description": "The service offering ID that defines the resources consumed by the service appliance", "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": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "The left (inside) network for service instance", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "leftnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "Project ID for the service instance", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "The right (outside) network ID for the service instance", + "length": 255, + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "An optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The template ID that specifies the image for the service appliance", + "length": 255, + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" } ], - "related": "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", + "related": "", "response": [ { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, { "description": "the account associated with the virtual machine", "name": "account", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "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 project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "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 project name of the vm", + "name": "project", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Releases a Public IP range back to the system pool", + "isasync": false, + "name": "releasePublicIpRange", + "params": [ { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the id of the Public IP range", + "length": 255, + "name": "id", + "related": "dedicatePublicIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "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 network that are using a netscaler load balancer device", + "isasync": false, + "name": "listNetscalerLoadBalancerNetworks", + "params": [ { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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 ISO attached to the virtual machine", - "name": "isoname", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "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 date this network was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 the nic", - "name": "gateway", - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the 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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - } - ], + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "the list of services", + "name": "service", "response": [ { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project 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 account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "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 destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" } ], - "type": "set" - }, + "type": "list" + } + ], + "type": "list" + }, + { + "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": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "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 cidr of IPv6 network", + "name": "ip6cidr", + "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 second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + {}, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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 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": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the project name of the vm", + "description": "the project name of the address", "name": "project", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "acl type - access type to the network", + "name": "acltype", + "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Starts a system virtual machine.", + "isasync": true, + "name": "startSystemVm", + "params": [ + { + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "migrateSystemVm,startSystemVm", + "required": true, + "type": "uuid" + } + ], + "related": "migrateSystemVm", + "response": [ + {}, + { + "description": "the systemvm agent version", + "name": "version", "type": "string" }, + {}, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the current status of the latest async job acting 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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the state of the system VM", + "name": "state", "type": "string" } ] }, { - "description": "Registers NCC Service Package", + "description": "Lists supported methods of network isolation", "isasync": false, - "name": "registerNetscalerServicePackage", + "name": "listNetworkIsolationMethods", "params": [ { - "description": "Name of the service Package.", + "description": "List by keyword", "length": 255, - "name": "name", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Description of Service Package", + "description": "", "length": 255, - "name": "description", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "listRegisteredServicePackages", + "related": "", "response": [ {}, { @@ -95911,12 +97984,7 @@ }, {}, { - "description": "Service Package UUID", - "name": "id", - "type": "string" - }, - { - "description": "Service Package Name", + "description": "Network isolation method name", "name": "name", "type": "string" }, @@ -95924,531 +97992,494 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "Description of Service Package", - "name": "description", - "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Add +-credits to an account", + "description": "Registers an existing VNF template into the CloudStack cloud. ", "isasync": false, - "name": "quotaCredits", + "name": "registerVnfTemplate", "params": [ { - "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", - "length": 255, - "name": "quota_enforce", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "boolean" - }, - { - "description": "Value of the credits to be added+, subtracted-", - "length": 255, - "name": "value", - "required": true, - "type": "double" + "type": "string" }, { - "description": "Account Id for which quota credits need to be added", + "description": "the name of the template", "length": 255, - "name": "account", + "name": "name", "required": true, "type": "string" }, { - "description": "Minimum balance threshold of the account", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "min_balance", + "name": "details", "required": false, - "type": "double" + "type": "map" }, { - "description": "Domain for which quota credits need to be added", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "the account name of the admin who updated the credits", - "name": "updated_on", - "type": "date" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, - {}, { - "description": "currency", - "name": "currency", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the user name of the admin who updated the credits", - "name": "updated_by", - "type": "string" + "description": "Register template for the project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "the credit deposited", - "name": "credits", - "type": "bigdecimal" - } - ], - "since": "4.7.0" - }, - { - "description": "Creates resource tag(s)", - "isasync": true, - "name": "createTags", - "params": [ + "description": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, { - "description": "type of the resource", + "description": "the tag for this template.", "length": 255, - "name": "resourcetype", - "required": true, + "name": "templatetag", + "required": false, "type": "string" }, { - "description": "Map of tags (key/value pairs)", + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", "length": 255, - "name": "tags", - "required": true, + "name": "vnfdetails", + "required": false, "type": "map" }, { - "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", "length": 255, - "name": "customer", + "name": "vnfnics", "required": false, - "type": "string" + "type": "map" }, { - "description": "list of resources to create the tags for", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", + "name": "deployasis", + "required": false, + "since": "4.15.1", "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": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "length": 255, + "name": "zoneids", + "related": "createZone,listZones", + "required": false, + "type": "list" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.0.0" - }, - { - "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", - "isasync": false, - "name": "listCaCertificate", - "params": [ { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "provider", + "name": "bits", "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 CA certificate(s)", - "name": "cacertificates", - "type": "string" + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" }, - {}, { - "description": "The client certificate", - "name": "certificate", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "Private key for the certificate", - "name": "privatekey", - "type": "string" + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.11.0" - }, - { - "description": "Create an Internal Load Balancer element.", - "isasync": true, - "name": "createInternalLoadBalancerElement", - "params": [ - { - "description": "the network service provider ID of the internal load balancer element", + "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": "nspid", - "related": "listNetworkServiceProviders", - "required": true, - "type": "uuid" - } - ], - "related": "configureInternalLoadBalancerElement", - "response": [ - { - "description": "the id of the internal load balancer element", - "name": "id", + "name": "checksum", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "Enabled/Disabled the element", - "name": "enabled", + "description": "true if the template is available to all accounts; default is true", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" - } - ], - "since": "4.2.0" - }, - { - "description": "Reset api count", - "isasync": false, - "name": "resetApiLimit", - "params": [ + }, { - "description": "the ID of the acount whose limit to be reset", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", - "related": "enableAccount,listAccounts,listAccounts", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Creates a VLAN IP range.", - "isasync": false, - "name": "deleteVlanIpRange", - "params": [ + "description": "the ID of the zone the template is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, { - "description": "the id of the VLAN IP range", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "id", - "related": "dedicatePublicIpRange", + "name": "format", "required": true, - "type": "uuid" + "type": "string" } ], + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} - ] - }, - { - "description": "Provisions a host with a direct download certificate", - "isasync": false, - "name": "provisionTemplateDirectDownloadCertificate", - "params": [ - { - "description": "the id of the direct download certificate to provision", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate", - "required": true, - "type": "uuid" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the host to provision the certificate", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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": "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" + } + ], + "type": "set" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", - "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 host", - "name": "hostname", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host", + "description": "the ID of the secondary storage host for the template", "name": "hostid", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "SAML Global Log Out API", - "isasync": false, - "name": "samlSlo", - "params": [], - "related": "logout", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, - {}, { - "description": "Response description", - "name": "description", + "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": "Creates a Project role", - "isasync": false, - "name": "updateProjectRole", - "params": [ + }, { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": false, + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "ID of the Project role", - "length": 255, - "name": "id", - "related": "updateProjectRole", - "required": true, - "type": "uuid" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, { - "description": "the name of the role", - "name": "name", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the id of the project", - "name": "projectid", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" - } - ], - "since": "4.15.0" - }, - { - "description": "Generates an alert", - "isasync": true, - "name": "generateAlert", - "params": [ + }, { - "description": "Zone id for which alert is generated", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "Pod id for which alert is generated", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, + {}, { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "Name of the alert", - "length": 255, - "name": "name", - "required": true, + "description": "the account name to which the template belongs", + "name": "account", "type": "string" - } - ], - "response": [ - {}, - {}, + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -96460,531 +98491,565 @@ "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + {}, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the template name", + "name": "name", "type": "string" } ], - "since": "4.3" + "since": "4.19.0" }, { - "description": "Add a new Ldap Configuration", + "description": "Lists host HA resources", "isasync": false, - "name": "addLdapConfiguration", + "name": "listHostHAResources", "params": [ { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, - { - "description": "Port", - "length": 255, - "name": "port", - "required": true, - "type": "integer" - }, - { - "description": "linked domain", + "description": "List by host ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" } ], - "related": "", + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, - { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" - }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "linked domain", - "name": "domainid", - "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 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": "operation status", + "name": "status", + "type": "boolean" + }, + {} ], - "since": "4.2.0" + "since": "4.11" }, { - "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", + "description": "Lists VM stats", "isasync": false, - "name": "ldapConfig", + "name": "listVirtualMachinesUsageHistory", "params": [ { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "", "length": 255, - "name": "hostname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "ssl", + "name": "startdate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "Enter the path to trust certificates store.", + "description": "", "length": 255, - "name": "truststore", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "the ID of the virtual machine.", "length": 255, - "name": "binddn", + "name": "id", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Enter the password for trust store.", + "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": "truststorepass", + "name": "name", "required": false, "type": "string" }, { - "description": "If true return current LDAP configuration", + "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, - "name": "listall", + "name": "ids", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "Specify the LDAP port if required, default is 389.", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "port", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "Enter the password.", + "description": "List by keyword", "length": 255, - "name": "bindpass", + "name": "keyword", "required": false, "type": "string" + } + ], + "related": "listSystemVmsUsageHistory", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", - "length": 255, - "name": "searchbase", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", - "length": 255, - "name": "queryfilter", - "required": false, + "description": "the list of VM stats", + "name": "stats", + "type": "list" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" - } - ], - "related": "ldapRemove", - "response": [ + }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, {}, - {}, + {} + ], + "since": "4.17" + }, + { + "description": "list Tungsten-Fabric firewall policy", + "isasync": false, + "name": "listTungstenFabricFirewallPolicy", + "params": [ { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": false, "type": "string" }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "DN password", - "name": "bindpass", - "type": "string" + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "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": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } - ], - "since": "3.0.0" + ] }, { - "description": "Deletes a port forwarding rule", + "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", "isasync": true, - "name": "deletePortForwardingRule", + "name": "declareHostAsDegraded", "params": [ { - "description": "the ID of the port forwarding rule", + "description": "host ID", "length": 255, "name": "id", - "related": "updateIpv6FirewallRule", + "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "moves a vpc to another physical network", - "isasync": true, - "name": "migrateVPC", - "params": [ + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, { - "description": "vpc offering ID", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the ID of the vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", - "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "true if previous network migration cmd failed", - "length": 255, - "name": "resume", - "required": false, + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" - } - ], - "related": "createVPC,listVPCs,updateVPC", - "response": [ - {}, + }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the IP address of the host", + "name": "ipaddress", "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": "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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "events available for the host", + "name": "events", "type": "string" }, - {}, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "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": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the list of supported services", - "name": "service", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", + "description": "the list of enabled vGPUs", + "name": "vgpu", "response": [ { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the capability name", - "name": "name", + "description": "Model Name of vGPU", + "name": "vgputype", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "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": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { @@ -96993,1171 +99058,1063 @@ "type": "integer" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the id of the VPC", - "name": "id", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ], - "since": "4.11.0" - }, - { - "description": "Deletes a global load balancer rule.", - "isasync": true, - "name": "deleteGlobalLoadBalancerRule", - "params": [ - { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the 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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "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 incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": true, + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" - } - ], - "related": "removeAnnotation", - "response": [ + }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" - }, - {}, - { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + } ], - "since": "4.16" + "since": "4.16.0.0" }, { - "description": "create Tungsten-Fabric address group", + "description": "Creates a Kubernetes cluster", "isasync": true, - "name": "createTungstenFabricAddressGroup", + "name": "createKubernetesCluster", "params": [ { - "description": "the ID of zone", + "description": "URL for the docker image private registry", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "dockerregistryurl", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric address group name", + "description": "password for the docker image private registry", "length": 255, - "name": "name", - "required": true, + "name": "dockerregistrypassword", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric ip prefix length", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "ipprefixlen", - "required": true, - "type": "integer" + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric ip prefix", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "ipprefix", + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "name for the Kubernetes cluster", + "length": 255, + "name": "name", "required": true, "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Tungsten-Fabric address group name", - "name": "name", + "description": "description for the Kubernetes cluster", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Deploy cluster for the project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "availability zone in which Kubernetes cluster to be launched", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", - "type": "string" + "description": "Network in which Kubernetes cluster is to be launched", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "root disk size in GB for each node", + "length": 255, + "name": "noderootdisksize", + "required": false, + "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "user name for the docker image private registry", + "length": 255, + "name": "dockerregistryusername", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "number of Kubernetes cluster control nodes, default is 1", + "length": 255, + "name": "controlnodes", + "required": false, "type": "long" }, - {}, - {}, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "length": 255, + "name": "clustertype", + "required": false, + "since": "4.19.0", "type": "string" - } - ] - }, - { - "description": "Lists BigSwitch BCF Controller devices", - "isasync": false, - "name": "listBigSwitchBcfDevices", - "params": [ + }, { - "description": "the Physical Network ID", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "pagesize", + "name": "keypair", "required": false, - "type": "integer" + "type": "string" }, { - "description": "bigswitch BCF controller device ID", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "masternodes", + "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": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "keyword", + "name": "externalloadbalanceripaddress", "required": false, "type": "string" }, { - "description": "", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "page", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "", + "related": "startKubernetesCluster", "response": [ { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, - {}, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, - {}, { - "description": "the controller password", - "name": "password", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "name of the provider", - "name": "provider", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the controller username", - "name": "username", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.6.0" - }, - { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "HA provider", - "length": 255, - "name": "provider", - "required": true, + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" - } - ], - "related": "disableHAForHost", - "response": [ + }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, - {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Updates a configuration.", - "isasync": false, - "name": "updateConfiguration", - "params": [ - { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "type": "uuid" }, { - "description": "the value of the configuration", - "length": 4096, - "name": "value", - "required": false, + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, + {}, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Account to update the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Zone to update the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "listSwifts,addImageStoreS3,listImageStores", - "required": false, - "type": "uuid" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", - "length": 255, + "description": "the ID of the domain in which the Kubernetes cluster exists", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the category of the configuration", - "name": "category", "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, - {}, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "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 type of the configuration value", - "name": "type", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, - {}, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "keypair details", + "name": "keypair", "type": "string" } ] }, { - "description": "Lists volume stats", + "description": "List a storage network IP range.", "isasync": false, - "name": "listVolumesUsageHistory", + "name": "listStorageNetworkIpRange", "params": [ { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "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).", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "the ID of the volume.", - "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "startdate", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "List by keyword", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id.", + "description": "", "length": 255, - "name": "ids", - "related": "migrateSystemVm", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" } ], - "related": "", + "related": "createStorageNetworkIpRange", "response": [ { - "description": "the name of the volume", - "name": "name", + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" + }, + { + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, {}, + { + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" }, { - "description": "the ID of the volume", - "name": "id", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the Pod uuid for the storage network IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + }, + { + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" + }, + {} ], - "since": "4.18.0" + "since": "3.0.0" }, { - "description": "Dedicates a Public IP range to an account", - "isasync": false, - "name": "dedicatePublicIpRange", + "description": "Configures a virtual router element.", + "isasync": true, + "name": "configureVirtualRouterElement", "params": [ { - "description": "account who will own the VLAN", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the id of the VLAN IP range", + "description": "the ID of the virtual router provider", "length": 255, "name": "id", - "related": "dedicatePublicIpRange", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": true, "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "enabled", "required": true, - "type": "uuid" - }, - { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "type": "boolean" } ], - "related": "", + "related": "listVirtualRouterElements", "response": [ { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the VLAN IP range", - "name": "description", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, + {}, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a specified domain", + "isasync": true, + "name": "deleteDomain", + "params": [ { - "description": "the start ip of the VLAN IP range", - "name": "startip", - "type": "string" + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" - }, + "description": "ID of domain to delete", + "length": 255, + "name": "id", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, + {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Enables HA for a host", + "isasync": true, + "name": "enableHAForHost", + "params": [ { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" - }, + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "configureHAForHost,disableHAForHost,listHostHAProviders", + "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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 domain name of the VLAN IP range", - "name": "domain", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, {}, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "if host HA is enabled for the host", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.11" }, { - "description": "Adds API permissions to a project role", - "isasync": false, - "name": "createProjectRolePermission", + "description": "Migrate volume", + "isasync": true, + "name": "migrateVolume", "params": [ { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, - "type": "string" - }, - { - "description": "ID of project where project role permission is to be created", + "description": "destination storage pool ID to migrate the volume to", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": true, "type": "uuid" }, { - "description": "ID of the project role", + "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": "projectroleid", + "name": "newdiskofferingid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { - "description": "The API name or wildcard rule such as list*", + "description": "the ID of the volume", "length": 255, - "name": "rule", + "name": "volumeid", + "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The description of the role permission", + "description": "if the volume should be live migrated when it is attached to a running vm", "length": 255, - "name": "description", + "name": "livemigrate", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the ID of the project", - "name": "projectid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, - {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", - "type": "string" - } - ], - "since": "4.15.0" - }, - { - "description": "lists registered service packages", - "isasync": false, - "name": "listRegisteredServicePackages", - "params": [ + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Service Package Name", - "name": "name", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "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": "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": "Description of Service Package", - "name": "description", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "Service Package UUID", - "name": "id", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" - } - ] - }, - { - "description": "Create a console endpoint to connect to a VM console", - "isasync": false, - "name": "createConsoleEndpoint", - "params": [ + }, { - "description": "ID of the VM", - "length": 255, + "description": "id of the virtual machine", "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" + "type": "string" }, { - "description": "(optional) extra security token, valid when the extra validation is enabled", - "length": 255, - "name": "token", - "required": false, + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "details in case of an error", - "name": "details", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the console url", - "name": "url", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the console websocket options", - "name": "websocket", - "type": "consoleendpointwebsocketresponse" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "true if the console endpoint is generated properly", - "name": "success", - "type": "boolean" - } - ], - "since": "4.18.0" - }, - { - "description": "Updates a project role permission and/or order", - "isasync": false, - "name": "updateProjectRolePermission", - "params": [ - { - "description": "Project Role permission rule id", - "length": 255, - "name": "projectrolepermissionid", - "related": "", - "required": false, - "type": "uuid" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", - "length": 255, - "name": "ruleorder", - "related": "", - "required": false, - "type": "list" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "", - "required": true, - "type": "uuid" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "Rule permission, can be: allow or deny", - "length": 255, - "name": "permission", - "required": false, + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "ID of project where project role permission is to be updated", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { "description": "the 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.15.0" - }, - { - "description": "Enables static NAT for given IP address", - "isasync": false, - "name": "enableStaticNat", - "params": [ - { - "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { - "description": "VM guest NIC secondary IP address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the public IP address ID for which static NAT feature is being enabled", - "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the virtual machine for enabling static NAT feature", - "length": 255, - "name": "virtualmachineid", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { @@ -98166,48 +100123,178 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + {}, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Deletes a Zone.", - "isasync": false, - "name": "deleteZone", + "description": "create Tungsten-Fabric application policy set", + "isasync": true, + "name": "createTungstenFabricApplicationPolicySet", "params": [ { - "description": "the ID of the Zone", + "description": "Tungsten-Fabric application policy set name", "length": 255, - "name": "id", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", "related": "createZone,listZones", "required": true, "type": "uuid" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "type": "string" }, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "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 provider zone id", + "name": "zoneid", + "type": "long" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -98217,355 +100304,441 @@ ] }, { - "description": "Adds user to a project", - "isasync": true, - "name": "addUserToProject", + "description": "A command to list events.", + "isasync": false, + "name": "listEvents", "params": [ { - "description": "Project role type to be assigned to the user - Admin/Regular", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "roletype", + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, + { + "description": "the type of the resource associated with the event", + "length": 255, + "name": "resourcetype", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "Name of the user to be added to the project", + "description": "List by keyword", "length": 255, - "name": "username", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "ID of the project to add the user to", + "description": "the time the event was entered", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "name": "entrytime", + "required": false, + "type": "integer" }, { - "description": "email ID of user to which invitation to the project is going to be sent", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "email", + "name": "level", "required": false, "type": "string" }, { - "description": "ID of the project role", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectroleid", - "related": "", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the resource associated with the event", + "length": 255, + "name": "resourceid", + "required": false, + "since": "4.17.0", + "type": "string" + }, + { + "description": "the ID of the event", + "length": 255, + "name": "id", + "related": "listEvents", "required": false, "type": "uuid" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the duration of the event", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" + }, + { + "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "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", + "description": "the event type (see event types)", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true to list archived events otherwise false", + "length": 255, + "name": "archived", + "required": false, + "since": "4.19.0", + "type": "boolean" }, - {} - ], - "since": "4.14" - }, - { - "description": "Disables HA cluster-wide", - "isasync": true, - "name": "disableHAForCluster", - "params": [ { - "description": "ID of the cluster", + "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": "clusterid", - "related": "addCluster", - "required": true, + "name": "startid", + "related": "listEvents", + "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": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], + "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 name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", + "name": "account", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the id of the resource", + "name": "resourceid", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "a brief description of the event", + "name": "description", "type": "string" }, - {} - ], - "since": "4.11" - }, - { - "description": "delete Tungsten-Fabric firewall policy", - "isasync": true, - "name": "deleteTungstenFabricFirewallPolicy", - "params": [ { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the state of the event", + "name": "state", + "type": "state" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "name": "username", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "whether the event is parented", + "name": "parentid", + "type": "string" + }, + { + "description": "the ID of the event", + "name": "id", + "type": "string" }, {}, + { + "description": "the type of the resource", + "name": "resourcetype", + "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 event level (INFO, WARN, ERROR)", + "name": "level", + "type": "string" + }, + { + "description": "the name of the resource", + "name": "resourcename", + "type": "string" + }, + { + "description": "the date the event was created", + "name": "created", + "type": "date" + }, + { + "description": "whether the event has been archived or not", + "name": "archived", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the id of the account's domain", + "name": "domainid", "type": "string" } ] }, { - "description": "Recovers a virtual machine.", - "isasync": false, - "name": "recoverVirtualMachine", + "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", + "isasync": true, + "name": "updateVMAffinityGroup", "params": [ + { + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "length": 255, + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" + }, { "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "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", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": " 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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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 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", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "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 name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the 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": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -98573,32 +100746,37 @@ "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -98607,13 +100785,8 @@ "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" }, { @@ -98627,8 +100800,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -98640,13 +100818,13 @@ "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { - "description": "the 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" }, { @@ -98655,13 +100833,8 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -98670,25 +100843,45 @@ "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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 account associated with the tag", + "name": "account", "type": "string" }, { @@ -98697,28 +100890,28 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the 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": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -98727,44 +100920,69 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -98773,107 +100991,147 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, - { - "description": "the 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -98882,120 +101140,230 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the 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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the 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 pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + {}, + {}, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { "description": "the description of the affinity group", "name": "description", "type": "string" }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, { "description": "the project name of the affinity group", "name": "project", "type": "string" }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, { "description": "virtual machine IDs associated with this affinity group", "name": "virtualmachineIds", "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" } ], "type": "set" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -99004,29 +101372,33 @@ "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -99034,58 +101406,38 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -99094,28 +101446,28 @@ "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -99124,8 +101476,8 @@ "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -99134,829 +101486,1040 @@ "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, { "description": "Type of adapter if available", "name": "adaptertype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "type": "set" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - {}, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - {}, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "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", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the 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 virtual machine", - "name": "id", + "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", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" - }, + } + ] + }, + { + "description": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Hypervisor type of the resource", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, + } + ], + "related": "configureHAForHost,disableHAForHost", + "response": [ { - "description": "true if high-availability is enabled, false otherwise", + "description": "if host HA is enabled for the host", "name": "haenable", "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, + {} + ], + "since": "4.11" + }, + { + "description": "Registers NCC Service Package", + "isasync": false, + "name": "registerNetscalerServicePackage", + "params": [ { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Description of Service Package", + "length": 255, + "name": "description", + "required": true, "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Name of the service Package.", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, + } + ], + "related": "listRegisteredServicePackages", + "response": [ { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Service Package UUID", + "name": "id", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Description of Service Package", + "name": "description", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "Service Package Name", + "name": "name", "type": "string" }, - { - "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": "upload an existing template into the CloudStack cloud. ", - "isasync": false, - "name": "getUploadParamsForTemplate", + "description": "Creates resource tag(s)", + "isasync": true, + "name": "createTags", "params": [ { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" - }, - { - "description": "an optional accountName. Must be used with domainId.", + "description": "list of resources to create the tags for", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "resourceids", + "required": true, + "type": "list" }, { - "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": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, - "name": "checksum", + "name": "customer", "required": false, "type": "string" }, { - "description": "Upload volume/template for the project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "true if the template is available to all accounts; default is true", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "tags", + "required": true, + "type": "map" }, { - "description": "the ID of the zone the volume/template is to be hosted on", + "description": "type of the resource", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "resourcetype", "required": true, - "type": "uuid" - }, + "type": "string" + } + ], + "response": [ { - "description": "true if the template or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the volume/template", - "length": 255, - "name": "name", - "required": true, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.0.0" + }, + { + "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", + "isasync": false, + "name": "listCaCertificate", + "params": [ { - "description": "true if this template requires HVM", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "requireshvm", + "name": "provider", "required": false, - "type": "boolean" - }, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + {}, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, + "description": "Private key for the certificate", + "name": "privatekey", "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "The client certificate", + "name": "certificate", "type": "string" }, { - "description": "Template details in key/value pairs.", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11.0" + }, + { + "description": "Create an Internal Load Balancer element.", + "isasync": true, + "name": "createInternalLoadBalancerElement", + "params": [ { - "description": "the target hypervisor for the template", + "description": "the network service provider ID of the internal load balancer element", "length": 255, - "name": "hypervisor", + "name": "nspid", + "related": "listNetworkServiceProviders", "required": true, + "type": "uuid" + } + ], + "related": "configureInternalLoadBalancerElement", + "response": [ + { + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, + "description": "Enabled/Disabled the element", + "name": "enabled", "type": "boolean" }, + {}, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Reset api count", + "isasync": false, + "name": "resetApiLimit", + "params": [ { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the ID of the account whose limit to be reset", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", + "related": "enableAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } ], - "related": "getUploadParamsForIso", "response": [ - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "4.6.0" + ] }, { - "description": "Resets network permissions.", + "description": "Creates a VLAN IP range.", "isasync": false, - "name": "resetNetworkPermissions", + "name": "deleteVlanIpRange", "params": [ { - "description": "the network ID", + "description": "the id of the VLAN IP range", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "dedicatePublicIpRange", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "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.17.0" + ] }, { - "description": "update Tungsten-Fabric loadbalancer health monitor", - "isasync": true, - "name": "updateTungstenFabricLBHealthMonitor", + "description": "Provisions a host with a direct download certificate", + "isasync": false, + "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "loadbalancer health monitor http method", + "description": "the id of the direct download certificate to provision", "length": 255, - "name": "httpmethodtype", - "required": false, - "type": "string" + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate", + "required": true, + "type": "uuid" }, { - "description": "loadbalancer health monitor type", + "description": "the host to provision the certificate", "length": 255, - "name": "type", + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, - "type": "string" - }, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "loadbalancer health monitor url path", - "length": 255, - "name": "urlpath", - "required": false, + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "loadbalancer health monitor timeout", - "length": 255, - "name": "timeout", - "required": true, - "type": "integer" + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" }, { - "description": "the ID of lb rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "loadbalancer health monitor expected code", - "length": 255, - "name": "expectedcode", - "required": false, + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "loadbalancer health monitor retry", - "length": 255, - "name": "retry", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "loadbalancer health monitor interval", - "length": 255, - "name": "interval", - "required": true, - "type": "integer" + "description": "the ID of the host", + "name": "hostid", + "type": "string" } ], - "related": "", - "response": [ + "since": "4.17.0" + }, + { + "description": "Generates an alert", + "isasync": true, + "name": "generateAlert", + "params": [ { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "Name of the alert", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, "type": "string" }, { - "description": "the health monitor type", + "description": "Type of the alert", + "length": 255, "name": "type", - "type": "string" + "required": true, + "type": "short" }, { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" + "description": "Zone id for which alert is generated", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Pod id for which alert is generated", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.3" + }, + { + "description": "Creates a Project role", + "isasync": false, + "name": "updateProjectRole", + "params": [ + { + "description": "creates a project role with this unique name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of project where role is being created", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the Project role", + "length": 255, + "name": "id", + "related": "updateProjectRole", + "required": true, + "type": "uuid" + }, + { + "description": "The description of the Project role", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the name of the role", + "name": "name", "type": "string" }, - {}, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "the id of the project", + "name": "projectid", + "type": "string" }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the ID of the role", + "name": "id", "type": "string" }, + {}, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the description of the role", + "name": "description", + "type": "string" } - ] + ], + "since": "4.15.0" }, { - "description": "Release the dedication for host", - "isasync": true, - "name": "releaseDedicatedHost", + "description": "Add a new Ldap Configuration", + "isasync": false, + "name": "addLdapConfiguration", "params": [ { - "description": "the ID of the host", + "description": "Hostname", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "hostname", "required": true, + "type": "string" + }, + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, "type": "uuid" + }, + { + "description": "Port", + "length": 255, + "name": "port", + "required": true, + "type": "integer" } ], + "related": "", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "linked domain", + "name": "domainid", "type": "string" }, {}, { - "description": "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.2.0" }, { - "description": "Accepts or declines project invitation", - "isasync": true, - "name": "updateProjectInvitation", + "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", + "isasync": false, + "name": "ldapConfig", "params": [ { - "description": "id of the project to join", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "name": "queryfilter", + "required": false, + "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "userid", - "related": "createUser,enableUser,getUser", + "name": "binddn", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true, accept the invitation, decline if false. True by default", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "accept", + "name": "ssl", "required": false, "type": "boolean" }, { - "description": "account that is joining the project", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "account", + "name": "searchbase", "required": false, "type": "string" }, { - "description": "list invitations for specified account; this parameter has to be specified with domainId", + "description": "Enter the password for trust store.", "length": 255, - "name": "token", + "name": "truststorepass", + "required": false, + "type": "string" + }, + { + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, + { + "description": "If true return current LDAP configuration", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "Enter the password.", + "length": 255, + "name": "bindpass", + "required": false, + "type": "string" + }, + { + "description": "Specify the LDAP port if required, default is 389.", + "length": 255, + "name": "port", + "required": false, + "type": "integer" + }, + { + "description": "Enter the path to trust certificates store.", + "length": 255, + "name": "truststore", "required": false, "type": "string" } ], + "related": "ldapRemove", "response": [ {}, - {}, + { + "description": "Specify the LDAP port if required, default is 389", + "name": "port", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", + "type": "string" + }, + { + "description": "DN password", + "name": "bindpass", + "type": "string" + }, + { + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", + "type": "string" + }, + { + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" } ], "since": "3.0.0" }, { - "description": "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", - "isasync": true, - "name": "revertSnapshot", + "description": "List vSphere storage policies", + "isasync": false, + "name": "listVsphereStoragePolicies", "params": [ { - "description": "The ID of the snapshot", + "description": "ID of the zone", "length": 255, - "name": "id", - "related": "revertSnapshot", - "required": true, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the availability zone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the Zone", "name": "zoneid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, + {}, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the description of the Storage Policy", + "name": "description", + "type": "string" + } + ] + }, + { + "description": "Deletes a port forwarding rule", + "isasync": true, + "name": "deletePortForwardingRule", + "params": [ + { + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "moves a vpc to another physical network", + "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": "the account associated with the snapshot", + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" + }, + { + "description": "vpc offering ID", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" + }, + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" + } + ], + "related": "createVPC,listVPCs,updateVPC", + "response": [ + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the owner of the VPC", "name": "account", "type": "string" }, + {}, + {}, { - "description": "the list of resource tags associated", + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { @@ -99965,23 +102528,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "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": "tag key name", + "name": "key", "type": "string" }, { @@ -99990,8 +102553,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -100003,110 +102571,216 @@ "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, - {}, { - "description": "id of the os on volume", - "name": "ostypeid", + "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": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", "type": "integer" }, - {}, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" - } - ] - }, - { - "description": "Updates a condition for VM auto scaling", - "isasync": true, - "name": "updateCondition", - "params": [ + }, { - "description": "Value for which the Counter will be evaluated with the Operator selected.", - "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the condition.", + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } + ], + "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": "", @@ -100115,18 +102789,11 @@ } ], "response": [ - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -100136,130 +102803,159 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } - ], - "since": "4.18.0" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {} + ] }, { - "description": "Lists Regions", + "description": "update an annotation visibility.", "isasync": false, - "name": "listRegions", + "name": "updateAnnotationVisibility", "params": [ { - "description": "", + "description": "the annotation is visible for admins only", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "adminsonly", + "required": true, + "type": "boolean" }, { - "description": "List Region by region ID.", + "description": "the id of the annotation", "length": 255, "name": "id", - "required": false, - "type": "integer" - }, + "required": true, + "type": "string" + } + ], + "related": "removeAnnotation", + "response": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "List Region by region name.", - "length": 255, - "name": "name", - "required": false, + "description": "the contents of the annotation", + "name": "annotation", "type": "string" - } - ], - "related": "addRegion", - "response": [ + }, { - "description": "the ID of the region", + "description": "the (uu)id of the annotation", "name": "id", - "type": "integer" + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" }, + {}, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, {}, { - "description": "the name of the region", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.16" }, { - "description": "Configures an Internal Load Balancer element.", + "description": "create Tungsten-Fabric address group", "isasync": true, - "name": "configureInternalLoadBalancerElement", + "name": "createTungstenFabricAddressGroup", "params": [ { - "description": "Enables/Disables the Internal Load Balancer element", + "description": "Tungsten-Fabric ip prefix", "length": 255, - "name": "enabled", + "name": "ipprefix", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the internal lb provider", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement", + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric ip prefix length", + "length": 255, + "name": "ipprefixlen", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric address group name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "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 uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, { "description": "the UUID of the latest async job acting on this object", @@ -100267,292 +102963,380 @@ "type": "string" }, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "Tungsten-Fabric address group name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {} - ], - "since": "4.2.0" + ] }, { - "description": "Attempts Migration of a system virtual machine to the host specified.", - "isasync": true, - "name": "migrateSystemVm", + "description": "Lists BigSwitch BCF Controller devices", + "isasync": false, + "name": "listBigSwitchBcfDevices", "params": [ { - "description": "destination Host ID to migrate VM to", + "description": "", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "description": "the Physical Network ID", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "since": "4.16.0", "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "bigswitch BCF controller device ID", "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm", - "required": true, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": false, "type": "uuid" }, { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "description": "", "length": 255, - "name": "autoselect", + "name": "pagesize", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "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": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "NAT support", + "name": "nat", + "type": "boolean" }, + {}, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the controller password", + "name": "password", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", - "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 system VM", - "name": "hostcontrolstate", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "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": "the template name for the system VM", - "name": "templatename", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the controller username", + "name": "username", "type": "string" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "Updates a configuration.", + "isasync": false, + "name": "updateConfiguration", + "params": [ { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the value of the configuration", + "length": 4096, + "name": "value", + "required": false, "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the ID of the Zone to update the parameter value for corresponding zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "type": "uuid" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the name of the configuration", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" + "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "listSwifts,addImageStoreS3,listImageStores", + "required": false, + "type": "uuid" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, + {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 hostname for the system VM", - "name": "hostname", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, - {}, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the category of the configuration", + "name": "category", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the name of the system VM", + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, + { + "description": "the name of the configuration", "name": "name", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the group of the configuration", + "name": "group", "type": "string" + } + ] + }, + { + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "HA provider", + "length": 255, + "name": "provider", + "required": true, "type": "string" + } + ], + "related": "disableHAForHost", + "response": [ + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + {}, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "operation status", + "name": "status", "type": "boolean" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the host HA provider", + "name": "haprovider", + "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "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" } - ] + ], + "since": "4.11" }, { - "description": "List the counters for VM auto scaling", + "description": "Lists volume stats", "isasync": false, - "name": "listCounters", + "name": "listVolumesUsageHistory", "params": [ { - "description": "Source of the counter.", + "description": "the ID of the volume.", "length": 255, - "name": "source", + "name": "id", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Name of the counter.", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "keyword", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "ID of the Counter.", + "description": "the IDs of the volumes, mutually exclusive with id.", "length": 255, - "name": "id", - "related": "createCounter,listCounters", + "name": "ids", + "related": "migrateSystemVm", "required": false, - "type": "uuid" + "type": "list" }, { "description": "", @@ -100562,124 +103346,97 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Network provider of the counter.", + "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, - "name": "provider", + "name": "name", "required": false, - "since": "4.18.0", "type": "string" + }, + { + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], - "related": "createCounter", + "related": "", "response": [ { - "description": "Source of the counter.", - "name": "source", + "description": "the ID of the volume", + "name": "id", "type": "string" }, {}, { - "description": "Name of the counter.", + "description": "the name of the volume", "name": "name", "type": "string" }, - { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", - "type": "string" - }, - { - "description": "the id of the Counter", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Provider of the counter.", - "name": "provider", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.18.0" }, { - "description": "remove Tungsten-Fabric tag", - "isasync": true, - "name": "removeTungstenFabricTag", + "description": "Dedicates a Public IP range to an account", + "isasync": false, + "name": "dedicatePublicIpRange", "params": [ { - "description": "the uuid of nics", - "length": 255, - "name": "nicuuid", - "required": false, - "type": "list" - }, - { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "account who will own the VLAN", "length": 255, - "name": "applicationpolicysetuuid", + "name": "account", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the id of the VLAN IP range", "length": 255, - "name": "taguuid", + "name": "id", + "related": "dedicatePublicIpRange", "required": true, - "type": "string" - }, - { - "description": "the uuid of vms", - "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" - }, - { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" }, { - "description": "the uuid of networks", + "description": "project who will own the VLAN", "length": 255, - "name": "networkuuid", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "list" + "type": "uuid" } ], - "related": "createTungstenFabricTag", + "related": "", "response": [ { "description": "the current status of the latest async job acting on this object", @@ -100687,313 +103444,213 @@ "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, - { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" - } - ] - }, - { - "description": "Lists all available virtual router elements.", - "isasync": false, - "name": "listVirtualRouterElements", - "params": [ - { - "description": "list network offerings by enabled state", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" }, { - "description": "list virtual router elements by network service provider id", - "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": false, - "type": "uuid" + "description": "the project name of the vlan range", + "name": "project", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "list virtual router elements by id", - "length": 255, - "name": "id", - "related": "listVirtualRouterElements", - "required": false, - "type": "uuid" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "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" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, - {}, { - "description": "the account associated with the provider", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" - } - ] - }, - { - "description": "Deletes snapshot policies for the account.", - "isasync": false, - "name": "deleteSnapshotPolicies", - "params": [ - { - "description": "list of snapshots policy IDs separated by comma", - "length": 255, - "name": "ids", - "related": "updateSnapshotPolicy", - "required": false, - "type": "list" }, - { - "description": "the Id of the snapshot policy", - "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", - "required": false, - "type": "uuid" - } - ], - "response": [ - {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" } ] }, { - "description": "Lists implementors of implementor of a network traffic type or implementors of all network traffic types", + "description": "Deletes an empty Bucket.", "isasync": false, - "name": "listTrafficTypeImplementors", + "name": "deleteBucket", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", + "description": "The ID of the Bucket", "length": 255, - "name": "traffictype", - "required": false, - "type": "string" + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], - "related": "", "response": [ { - "description": "network traffic type", - "name": "traffictype", - "type": "string" - }, - { - "description": "implementor of network traffic type", - "name": "traffictypeimplementor", + "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": "3.0.0" + "since": "4.19.0" }, { - "description": "link a cloudstack account to a group or OU in ldap", + "description": "Adds API permissions to a project role", "isasync": false, - "name": "linkAccountToLdap", + "name": "createProjectRolePermission", "params": [ { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, - "type": "string" - }, - { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "The rule permission, allow or deny. Default: deny.", "length": 255, - "name": "type", - "required": false, + "name": "permission", + "required": true, "type": "string" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "ID of the project role", "length": 255, - "name": "accounttype", + "name": "projectroleid", + "related": "", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "name of the group or OU in LDAP", + "description": "The description of the role permission", "length": 255, - "name": "ldapdomain", - "required": true, + "name": "description", + "required": false, "type": "string" }, { - "description": "The id of the domain that is to contain the linked account.", + "description": "ID of project where project role permission is to be created", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "activateProject,suspendProject", "required": true, "type": "uuid" }, { - "description": "name of the account, it will be created if it does not exist", + "description": "The API name or wildcard rule such as list*", "length": 255, - "name": "account", + "name": "rule", "required": true, "type": "string" } @@ -101001,998 +103658,986 @@ "related": "", "response": [ { - "description": "type of the name in LDAP which is linke to the domain", - "name": "type", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the api name or wildcard rule", + "name": "rule", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "list the db hosts and statistics", - "isasync": false, - "name": "listDbMetrics", - "params": [], - "related": "", - "response": [ + {}, {}, { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "lists registered service packages", + "isasync": false, + "name": "listRegisteredServicePackages", + "params": [ { - "description": "the number of connections to the DB", - "name": "connections", - "type": "int" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the last measured load averages on the DB", - "name": "dbloadaverages", - "type": "double[]" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Service Package UUID", + "name": "id", "type": "string" }, {}, { - "description": "the version of the currently running DB", - "name": "versioncomment", + "description": "Description of Service Package", + "name": "description", "type": "string" }, { - "description": "the version of the currently running DB", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "Service Package Name", + "name": "name", "type": "string" }, + {}, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, - { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.17.0" + ] }, { - "description": "Deletes an image store or Secondary Storage.", + "description": "Create a console endpoint to connect to a VM console", "isasync": false, - "name": "deleteImageStore", + "name": "createConsoleEndpoint", "params": [ { - "description": "The image store ID or Secondary Storage ID.", + "description": "(optional) extra security token, valid when the extra validation is enabled", "length": 255, - "name": "id", - "related": "listSwifts,addImageStoreS3,listImageStores", + "name": "token", + "required": false, + "type": "string" + }, + { + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], + "related": "", "response": [ - {}, + { + "description": "the console url", + "name": "url", + "type": "string" + }, + { + "description": "true if the console endpoint is generated properly", + "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 console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "details in case of an error", + "name": "details", + "type": "string" + }, + {}, + {} ], - "since": "4.2.0" + "since": "4.18.0" }, { - "description": "Lists autoscale vm profiles.", + "description": "Updates a project role permission and/or order", "isasync": false, - "name": "listAutoScaleVmProfiles", + "name": "updateProjectRolePermission", "params": [ { - "description": "", + "description": "Project Role permission rule id", "length": 255, - "name": "page", + "name": "projectrolepermissionid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "ID of project where project role permission is to be updated", "length": 255, - "name": "otherdeployparams", - "required": false, - "type": "string" + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "pagesize", + "name": "ruleorder", + "related": "", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the ID of the autoscale vm profile", + "description": "ID of the project role", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", - "required": false, + "name": "projectroleid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "account", + "name": "permission", "required": false, "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, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "availability zone for the auto deployed virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Enables static NAT for given IP address", + "isasync": false, + "name": "enableStaticNat", + "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the templateid of the autoscale vm profile", + "description": "the public IP address ID for which static NAT feature is being enabled", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, "type": "uuid" }, { - "description": "list profiles by service offering id", + "description": "VM guest NIC secondary IP address for the port forwarding rule", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "vmguestip", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the virtual machine for enabling static NAT feature", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "virtualmachineid", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" } ], - "related": "createAutoScaleVmProfile", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Deletes a Zone.", + "isasync": false, + "name": "deleteZone", + "params": [ { - "description": "the autoscale vm profile ID", + "description": "the ID of the Zone", + "length": 255, "name": "id", - "type": "string" - }, + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "is profile for display to the regular user", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, {}, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "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 user to a project", + "isasync": true, + "name": "addUserToProject", + "params": [ { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "Project role type to be assigned to the user - Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "Name of the user to be added to the project", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - } - ] - }, - { - "description": "Disables out-of-band management for a host", - "isasync": true, - "name": "disableOutOfBandManagementForHost", - "params": [ - { - "description": "the ID of the host", + "description": "ID of the project to add the user to", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "projectid", + "related": "activateProject,suspendProject", "required": true, "type": "uuid" + }, + { + "description": "email ID of user to which invitation to the project is going to be sent", + "length": 255, + "name": "email", + "required": false, + "type": "string" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ { - "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", + "description": "true if operation is executed successfully", + "name": "success", "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 interface password", - "name": "password", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.14" + }, + { + "description": "Disables HA cluster-wide", + "isasync": true, + "name": "disableHAForCluster", + "params": [ { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.11" + }, + { + "description": "delete Tungsten-Fabric firewall policy", + "isasync": true, + "name": "deleteTungstenFabricFirewallPolicy", + "params": [ { - "description": "the operation result description", - "name": "description", + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": true, "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the 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": "true if out-of-band management is enabled for the host", - "name": "enabled", - "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": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", - "isasync": true, - "name": "cancelHostAsDegraded", + "description": "Recovers a virtual machine.", + "isasync": false, + "name": "recoverVirtualMachine", "params": [ { - "description": "host ID", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,reconnectHost", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "events available for the host", - "name": "events", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "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", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "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 ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, - {}, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "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": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the host version", - "name": "version", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "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 no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - } - ], - "since": "4.16.0.0" - }, - { - "description": "Authorizes a particular ingress rule for this security group", - "isasync": true, - "name": "authorizeSecurityGroupIngress", - "params": [ - { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "an optional project of the security group", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "user to security group mapping", - "length": 255, - "name": "usersecuritygrouplist", - "required": false, - "type": "map" - }, - { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", - "length": 255, - "name": "securitygroupname", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", - "required": false, - "type": "uuid" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "end port for this ingress rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "start port for this ingress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", - "length": 255, - "name": "protocol", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" - } - ], - "related": "", - "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", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", + "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 pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -102006,291 +104651,87 @@ "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ] - }, - { - "description": "Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)", - "isasync": true, - "name": "syncStoragePool", - "params": [ - { - "description": "Storage pool id", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", - "response": [ - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" - }, - { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" - }, - { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - }, - { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the 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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, - { - "description": "the storage pool type", - "name": "type", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the name of the storage pool", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, - {} - ], - "since": "4.15.1" - }, - { - "description": "Creates a security group", - "isasync": false, - "name": "createSecurityGroup", - "params": [ - { - "description": "the description of the security group", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", - "length": 255, + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "name of the security group", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Create security group for project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", + "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 domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -102300,610 +104741,655 @@ "name": "key", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 domain associated with the tag", - "name": "domainid", + "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "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 project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "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", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Removes a VM from any existing backup offering", - "isasync": true, - "name": "removeVirtualMachineFromBackupOffering", - "params": [ - { - "description": "Whether to force remove VM from the backup offering that may also delete VM backups.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.14.0" - }, - { - "description": "List network visibility and all accounts that have permissions to view this network.", - "isasync": false, - "name": "listNetworkPermissions", - "params": [ { - "description": "Lists network permission by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "the network ID", - "name": "networkid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "the project the network is available for", - "name": "project", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the account the network is available for", - "name": "account", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of project the network is available for", - "name": "projectid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "Recalculate and update resource count for an account or domain.", + "description": "upload an existing template into the CloudStack cloud. ", "isasync": false, - "name": "updateResourceCount", + "name": "getUploadParamsForTemplate", "params": [ { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "resourcetype", + "name": "bits", "required": false, "type": "integer" }, { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "account", + "name": "isextractable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Update resource limits for project", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", + "description": "the tag for this template.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the project name for which resource count's are updated", - "name": "project", + "name": "templatetag", + "required": false, "type": "string" }, { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "resource count", - "name": "resourcecount", - "type": "long" - }, - { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 project id for which resource count's are updated", + "description": "Upload volume/template/iso for the project", + "length": 255, "name": "projectid", - "type": "string" - }, - { - "description": "the account for which resource count's are updated", - "name": "account", - "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" + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" }, - {}, { - "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 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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists site 2 site vpn gateways", - "isasync": false, - "name": "listVpnGateways", - "params": [ - { - "description": "list only resources belonging to the domain specified", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "listall", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "the name of the volume/template/iso", "length": 255, - "name": "keyword", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "fordisplay", + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "id of the vpn gateway", + "description": "true if this template requires HVM", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways", + "name": "requireshvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "pagesize", + "name": "sshkeyenabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "page", + "name": "isdynamicallyscalable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Template details in key/value pairs.", "length": 255, - "name": "isrecursive", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "id of vpc", + "description": "the target hypervisor for the template", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "length": 255, + "name": "deployasis", "required": false, - "type": "uuid" + "since": "4.15.1", + "type": "boolean" } ], - "related": "createVpnGateway", + "related": "getUploadParamsForIso", "response": [ { - "description": "the project name", - "name": "project", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, {}, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, { @@ -102912,29 +105398,38 @@ "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", - "type": "string" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, + {} + ], + "since": "4.6.0" + }, + { + "description": "Resets network permissions.", + "isasync": false, + "name": "resetNetworkPermissions", + "params": [ { - "description": "the project id", - "name": "projectid", - "type": "string" - }, + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -102942,1499 +105437,1164 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "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" } - ] + ], + "since": "4.17.0" }, { - "description": "Lists dynamic roles in CloudStack", - "isasync": false, - "name": "listRoles", + "description": "update Tungsten-Fabric loadbalancer health monitor", + "isasync": true, + "name": "updateTungstenFabricLBHealthMonitor", "params": [ { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "loadbalancer health monitor expected code", "length": 255, - "name": "type", + "name": "expectedcode", "required": false, "type": "string" }, { - "description": "List role by role ID.", + "description": "loadbalancer health monitor retry", "length": 255, - "name": "id", - "related": "importRole,listRoles", - "required": false, - "type": "uuid" + "name": "retry", + "required": true, + "type": "integer" }, { - "description": "", + "description": "loadbalancer health monitor interval", "length": 255, - "name": "pagesize", - "required": false, + "name": "interval", + "required": true, "type": "integer" }, { - "description": "List role by role name.", + "description": "the ID of lb rule", "length": 255, - "name": "name", - "required": false, + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "description": "loadbalancer health monitor type", + "length": 255, + "name": "type", + "required": true, "type": "string" }, { - "description": "", + "description": "loadbalancer health monitor timeout", "length": 255, - "name": "page", - "required": false, + "name": "timeout", + "required": true, "type": "integer" }, { - "description": "List by keyword", + "description": "loadbalancer health monitor url path", "length": 255, - "name": "keyword", + "name": "urlpath", + "required": false, + "type": "string" + }, + { + "description": "loadbalancer health monitor http method", + "length": 255, + "name": "httpmethodtype", "required": false, "type": "string" } ], - "related": "importRole", + "related": "", "response": [ { - "description": "the ID of the role", - "name": "id", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the health monitor UUID", + "name": "uuid", + "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the health monitor interval", + "name": "interval", + "type": "int" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the health monitor type", + "name": "type", + "type": "string" }, - {}, { - "description": "the description of the role", - "name": "description", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, + {}, { - "description": "the name of the role", - "name": "name", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "list Tungsten-Fabric policy", - "isasync": false, - "name": "listTungstenFabricPolicy", - "params": [ + }, { - "description": "the ID of network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": false, - "type": "string" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "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": "", - "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 zone", - "length": 255, + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, + "type": "long" + } + ] + }, + { + "description": "Release the dedication for host", + "isasync": true, + "name": "releaseDedicatedHost", + "params": [ { - "description": "the ID of ip address", + "description": "the ID of the host", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "", "response": [ + {}, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, { - "description": "Retrieves a cloud identifier.", - "isasync": false, - "name": "getCloudIdentifier", + "description": "Accepts or declines project invitation", + "isasync": true, + "name": "updateProjectInvitation", "params": [ { - "description": "the user ID for the cloud identifier", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, "name": "userid", "related": "createUser,enableUser,getUser", - "required": true, + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the user ID for the cloud identifier", - "name": "userid", + "description": "list invitations for specified account; this parameter has to be specified with domainId", + "length": 255, + "name": "token", + "required": false, "type": "string" }, { - "description": "the cloud identifier", - "name": "cloudidentifier", - "type": "string" + "description": "id of the project to join", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "the signed response for the cloud identifier", - "name": "signature", + "description": "if true, accept the invitation, decline if false. True by default", + "length": 255, + "name": "accept", + "required": false, + "type": "boolean" + }, + { + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, "type": "string" + } + ], + "response": [ + { + "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": "3.0.0" }, { - "description": "Creates a load balancer stickiness policy ", + "description": "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", "isasync": true, - "name": "createLBStickinessPolicy", + "name": "revertSnapshot", "params": [ { - "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", - "length": 255, - "name": "methodname", - "required": true, - "type": "string" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the load balancer rule", + "description": "The ID of the snapshot", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "id", + "related": "revertSnapshot,listSnapshots", "required": true, "type": "uuid" - }, + } + ], + "related": "listSnapshots", + "response": [ { - "description": "the description of the load balancer stickiness policy", - "length": 255, - "name": "description", - "required": false, + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", - "length": 255, - "name": "param", - "required": false, - "type": "map" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "name of the load balancer stickiness policy", - "length": 255, - "name": "name", - "required": true, + "description": "the status of the template", + "name": "status", "type": "string" - } - ], - "related": "listLBStickinessPolicies", - "response": [ + }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, + {}, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, - {}, { - "description": "the state of the policy", - "name": "state", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, + {}, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Configures a Palo Alto firewall device", - "isasync": true, - "name": "configurePaloAltoFirewall", - "params": [ - { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" }, { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "fwdevicecapacity", - "required": false, - "type": "long" - } - ], - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", - "response": [ - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "type of the disk volume", + "name": "volumetype", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the account associated with the snapshot", + "name": "account", "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": "device name", - "name": "fwdevicename", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "device capacity", - "name": "fwdevicecapacity", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" } ] }, { - "description": "Updates ACL item with specified ID", + "description": "Updates a condition for VM auto scaling", "isasync": true, - "name": "updateNetworkACLItem", + "name": "updateCondition", "params": [ { - "description": "scl entry action, allow or deny", - "length": 255, - "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": "Value for which the Counter will be evaluated with the Operator selected.", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "threshold", + "required": true, + "type": "long" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, - "name": "reason", - "required": false, + "name": "relationaloperator", + "required": true, "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "the ID of the condition.", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "The network of the vm the ACL will be created for", - "length": 255, - "name": "number", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", - "length": 255, - "name": "partialupgrade", - "required": false, - "type": "boolean" - }, + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.18.0" + }, + { + "description": "Lists Regions", + "isasync": false, + "name": "listRegions", + "params": [ { - "description": "the starting port of ACL", + "description": "", "length": 255, - "name": "startport", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the network ACL item", + "description": "List Region by region ID.", "length": 255, "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" - }, - { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", "required": false, - "type": "string" + "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "List Region by region name.", "length": 255, - "name": "traffictype", + "name": "name", "required": false, "type": "string" }, { - "description": "error code for this ICMP message", + "description": "", "length": 255, - "name": "icmpcode", + "name": "pagesize", "required": false, "type": "integer" } ], - "related": "moveNetworkAclItem", + "related": "addRegion", "response": [ { - "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 Item", - "name": "id", - "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": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", "type": "boolean" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the name of the region", + "name": "name", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", + "description": "the ID of the region", + "name": "id", "type": "integer" }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "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 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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - } + {} ] }, { - "description": "Moves a user to another account", - "isasync": false, - "name": "moveUser", + "description": "Configures an Internal Load Balancer element.", + "isasync": true, + "name": "configureInternalLoadBalancerElement", "params": [ { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Enables/Disables the Internal Load Balancer element", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "enabled", + "required": true, + "type": "boolean" }, { - "description": "id of the user to be deleted", + "description": "the ID of the internal lb provider", "length": 255, "name": "id", - "related": "createUser,enableUser,getUser", + "related": "configureInternalLoadBalancerElement", "required": true, "type": "uuid" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Enabled/Disabled the element", + "name": "enabled", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {} ], - "since": "4.11" + "since": "4.2.0" }, { - "description": "List routers.", - "isasync": false, - "name": "listRouters", + "description": "Attempts Migration of a system virtual machine to the host specified.", + "isasync": true, + "name": "migrateSystemVm", "params": [ { - "description": "the Zone ID of the router", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.16.0", "type": "uuid" }, { - "description": "the state of the router", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the virtual machine", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "virtualmachineid", + "related": "migrateSystemVm", + "required": true, "type": "uuid" }, { - "description": "list by network id", + "description": "destination Host ID to migrate VM to", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "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": "fetchhealthcheckresults", + "name": "autoselect", "required": false, - "since": "4.14", + "since": "4.16.0", "type": "boolean" - }, + } + ], + "related": "", + "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, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, + {}, { - "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": "if true is passed for this parameter, list only VPC routers", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, + {}, { - "description": "the cluster ID of the router", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the name of the router", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "List networks by VPC", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "the host ID of the router", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": false, - "type": "uuid" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "list virtual router elements by version", - "length": 255, - "name": "version", - "required": false, + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the disk router", - "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the Pod ID of the router", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "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 template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "guest vlan range", + "name": "guestvlan", "type": "string" - } - ], - "related": "destroyRouter", - "response": [ + }, { - "description": "the hostname for the router", + "description": "the hostname for the system VM", "name": "hostname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Pod name for the router", + "description": "the Pod name for the system VM", "name": "podname", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the Zone ID for the router", + "description": "the Zone ID for the system VM", "name": "zoneid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "role of the domain router", - "name": "role", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the public MAC address for the router", + "description": "the public MAC address for the system VM", "name": "publicmacaddress", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "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", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the state of the system VM", + "name": "state", + "type": "string" + } + ] + }, + { + "description": "List the counters for VM auto scaling", + "isasync": false, + "name": "listCounters", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "ID of the Counter.", + "length": 255, + "name": "id", + "related": "createCounter,listCounters", + "required": false, + "type": "uuid" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "Name of the counter.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "Network provider of the counter.", + "length": 255, + "name": "provider", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "Source of the counter.", + "length": 255, + "name": "source", + "required": false, "type": "string" - }, + } + ], + "related": "createCounter", + "response": [ + {}, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "Source of the counter.", + "name": "source", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the domain associated with the router", - "name": "domain", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Provider of the counter.", + "name": "provider", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the id of the Counter", + "name": "id", "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": "remove Tungsten-Fabric tag", + "isasync": true, + "name": "removeTungstenFabricTag", + "params": [ { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "the uuid of vms", + "length": 255, + "name": "vmuuid", + "required": false, + "type": "list" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "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 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": "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 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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the 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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "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": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - } - ], - "type": "set" + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, + "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "the uuid of nics", + "length": 255, + "name": "nicuuid", + "required": false, + "type": "list" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, - {}, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "the uuid of networks", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "list" + } + ], + "related": "createTungstenFabricTag", + "response": [ + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, + {}, { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "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": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" - } - ] - }, - { - "description": "Releases host reservation.", - "isasync": true, - "name": "releaseHostReservation", - "params": [ - { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "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": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, { - "description": "list Tungsten-Fabric vm", + "description": "Lists all available virtual router elements.", "isasync": false, - "name": "listTungstenFabricVm", + "name": "listVirtualRouterElements", "params": [ { - "description": "the uuid of Tungsten-Fabric vm", + "description": "", "length": 255, - "name": "vmuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -104446,97 +106606,169 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "list virtual router elements by network service provider id", "length": 255, - "name": "pagesize", + "name": "nspid", + "related": "listNetworkServiceProviders", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "list virtual router elements by id", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "listVirtualRouterElements", "required": false, "type": "uuid" + }, + { + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], "related": "", "response": [ - {}, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric vm name", - "name": "name", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "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", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the id of the router", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" } ] }, { - "description": "Create site to site vpn connection", - "isasync": true, - "name": "createVpnConnection", + "description": "Deletes snapshot policies for the account.", + "isasync": false, + "name": "deleteSnapshotPolicies", "params": [ { - "description": "connection is passive or not", + "description": "the Id of the snapshot policy", "length": 255, - "name": "passive", + "name": "id", + "related": "updateSnapshotPolicy", + "required": false, + "type": "uuid" + }, + { + "description": "list of snapshots policy IDs separated by comma", + "length": 255, + "name": "ids", + "related": "updateSnapshotPolicy", "required": false, + "type": "list" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" + } + ] + }, + { + "description": "Lists implementors of implementor of a network traffic type or implementors of all network traffic types", + "isasync": false, + "name": "listTrafficTypeImplementors", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "id of the vpn gateway", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "s2svpngatewayid", - "related": "createVpnGateway", - "required": true, - "type": "uuid" + "name": "traffictype", + "required": false, + "type": "string" }, { - "description": "id of the customer gateway", + "description": "List by keyword", "length": 255, - "name": "s2scustomergatewayid", - "related": "createVpnCustomerGateway", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" } ], "related": "", @@ -104546,66 +106778,96 @@ "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "implementor of network traffic type", + "name": "traffictypeimplementor", "type": "string" }, + {}, + {}, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "network traffic type", + "name": "traffictype", "type": "string" }, { - "description": "the domain id of the owner", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "link a cloudstack account to a group or OU in ldap", + "isasync": false, + "name": "linkAccountToLdap", + "params": [ + { + "description": "The id of the domain that is to contain the linked account.", + "length": 255, "name": "domainid", - "type": "string" + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" }, { - "description": "the project name", - "name": "project", + "description": "name of the account, it will be created if it does not exist", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "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": "the domain name of the owner", - "name": "domain", + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", + "required": false, "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "length": 255, + "name": "type", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "the public IP address", - "name": "publicip", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -104614,214 +106876,308 @@ "type": "integer" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", + "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", + "type": "string" + }, + {} + ], + "since": "4.11.0" + }, + { + "description": "list the db hosts and statistics", + "isasync": false, + "name": "listDbMetrics", + "params": [], + "related": "", + "response": [ + {}, + { + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the version of the currently running DB", + "name": "version", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the version of the currently running DB", + "name": "versioncomment", "type": "string" }, + {}, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "long" }, { - "description": "the connection ID", - "name": "id", + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "the number of queries performed on the DB", + "name": "queries", "type": "long" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" + }, + { + "description": "the name of the active usage server", + "name": "hostname", "type": "string" } - ] + ], + "since": "4.17.0" }, { - "description": "lists network that are using a brocade vcs switch", + "description": "Deletes an image store or Secondary Storage.", "isasync": false, - "name": "listBrocadeVcsDeviceNetworks", + "name": "deleteImageStore", "params": [ { - "description": "List by keyword", + "description": "The image store ID or Secondary Storage ID.", "length": 255, - "name": "keyword", - "required": false, + "name": "id", + "related": "listSwifts,addImageStoreS3,listImageStores", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "", + "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": "Lists autoscale vm profiles.", + "isasync": false, + "name": "listAutoScaleVmProfiles", + "params": [ + { + "description": "list profiles by service offering id", "length": 255, - "name": "pagesize", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "integer" + "since": "4.4", + "type": "uuid" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "brocade vcs switch 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": "vcsdeviceid", - "related": "", - "required": true, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "required": false, "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "response": [ + }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the otherdeployparameters of the autoscale vm profile", + "length": 255, + "name": "otherdeployparams", + "required": false, "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "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", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "the templateid of the autoscale vm profile", + "length": 255, + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createAutoScaleVmProfile", + "response": [ + { + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "is profile for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the project id vm profile", + "name": "projectid", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -104829,695 +107185,495 @@ }, {}, { - "description": "The external id of the network", - "name": "externalid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the account owning the instance group", + "name": "account", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Base 64 encoded VM user data", + "name": "userdata", "type": "string" }, + {} + ] + }, + { + "description": "Disables out-of-band management for a host", + "isasync": true, + "name": "disableOutOfBandManagementForHost", + "params": [ { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", + "response": [ + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the 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", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, + {}, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the operation result description", + "name": "description", "type": "string" }, + {}, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + } + ], + "since": "4.9.0" + }, + { + "description": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", + "isasync": true, + "name": "cancelHostAsDegraded", + "params": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, + "description": "host ID", + "length": 255, + "name": "id", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "reconnectHost,addBaremetalHost", + "response": [ { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the date this network was created", - "name": "created", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the list of services", - "name": "service", + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", "response": [ { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "Model Name of vGPU", + "name": "vgputype", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, - {} - ] - }, - { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "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": "Tungsten-Fabric policy rule destination ip prefix length", - "length": 255, - "name": "destipprefixlen", - "required": true, - "type": "integer" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source end port", - "length": 255, - "name": "srcendport", - "required": true, - "type": "integer" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "Tungsten-Fabric policy rule protocol", - "length": 255, - "name": "protocol", - "required": true, + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "Tungsten-Fabric policy rule action", - "length": 255, - "name": "action", - "required": true, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", - "length": 255, - "name": "destipprefix", - "required": true, + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy rule destination end port", - "length": 255, - "name": "destendport", - "required": true, - "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": "Tungsten-Fabric policy rule source ip prefix length", - "length": 255, - "name": "srcipprefixlen", - "required": true, - "type": "integer" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "Tungsten-Fabric policy rule destination network", - "length": 255, - "name": "destnetwork", - "required": true, + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric policy rule source network", - "length": 255, - "name": "srcnetwork", - "required": true, + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "Tungsten-Fabric policy rule source start port", - "length": 255, - "name": "srcstartport", - "required": true, - "type": "integer" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "Tungsten-Fabric policy rule direction", - "length": 255, - "name": "direction", - "required": true, + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination start port", - "length": 255, - "name": "deststartport", - "required": true, - "type": "integer" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", - "length": 255, - "name": "srcipprefix", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, - {}, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, - {}, - { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", - "type": "string" - } - ] - }, - { - "description": "Dedicates a host.", - "isasync": true, - "name": "dedicateHost", - "params": [ { - "description": "the ID of the host to update", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "listDedicatedHosts", - "response": [ - {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, + {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", - "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", @@ -105525,45 +107681,49 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the Account ID of the host", - "name": "accountid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the domain ID of the host", - "name": "domainid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, - {} - ] + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + } + ], + "since": "4.16.0.0" }, { - "description": "Removes vpn user", + "description": "Authorizes a particular ingress rule for this security group", "isasync": true, - "name": "removeVpnUser", + "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "username for the vpn user", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "username", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "remove vpn user from the project", + "description": "an optional project of the security group", "length": 255, "name": "projectid", "related": "activateProject,suspendProject", @@ -105571,393 +107731,488 @@ "type": "uuid" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "type of the icmp message being sent", "length": 255, - "name": "account", + "name": "icmptype", "required": false, - "type": "string" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "user to security group mapping", + "length": 255, + "name": "usersecuritygrouplist", + "required": false, + "type": "map" }, - {} - ] - }, - { - "description": "Adds the GloboDNS external host", - "isasync": true, - "name": "addGloboDnsHost", - "params": [ { - "description": "Password for GloboDNS", + "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": "password", - "required": true, + "name": "protocol", + "required": false, "type": "string" }, { - "description": "GloboDNS url", + "description": "start port for this ingress rule", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "Username for GloboDNS", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "securitygroupid", + "related": "createSecurityGroup", + "required": false, + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, "type": "uuid" + }, + { + "description": "end port for this ingress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" } ], + "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, - {} - ], - "since": "4.5.0" - }, - { - "description": "Logs out the user", - "isasync": false, - "name": "logout", - "params": [], - "related": "", - "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, {}, { - "description": "Response description", - "name": "description", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { - "description": "Deletes a load balancer health check policy.", + "description": "Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)", "isasync": true, - "name": "deleteLBHealthCheckPolicy", + "name": "syncStoragePool", "params": [ { - "description": "the ID of the load balancer health check policy", + "description": "Storage pool id", "length": 255, "name": "id", - "related": "", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": true, "type": "uuid" } ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Imports a role based on provided map of rule permissions", - "isasync": false, - "name": "importRole", - "params": [ { - "description": "Creates a role with this unique name", - "length": 255, - "name": "name", - "required": true, + "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 description of the role", - "length": 255, - "name": "description", - "required": false, + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", - "length": 255, - "name": "rules", - "required": true, - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", - "length": 255, - "name": "type", - "required": false, + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, { - "description": "the name of the role", - "name": "name", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, - {}, { - "description": "the type of the role", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the role", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - } - ], - "since": "4.15.0" - }, - { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the host", - "name": "hostid", + "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": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, - {}, - {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" - } + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + {} ], - "since": "4.11" + "since": "4.15.1" }, { - "description": "List Swift.", + "description": "Creates a security group", "isasync": false, - "name": "listSwifts", + "name": "createSecurityGroup", "params": [ { - "description": "", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the id of the swift", + "description": "name of the security group", "length": 255, - "name": "id", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Create security group for project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "", + "description": "the description of the security group", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" } ], - "related": "addImageStoreS3,listImageStores", + "related": "", "response": [ { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the image store", + "description": "the name of the security group", "name": "name", "type": "string" }, {}, {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "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", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the UUID of the latest async job acting on this object", @@ -105965,94 +108220,296 @@ "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the group", + "name": "project", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "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 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 protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "3.0.0" + ] }, { - "description": "Enables out-of-band management for a host", - "isasync": true, - "name": "enableOutOfBandManagementForHost", + "description": "List network visibility and all accounts that have permissions to view this network.", + "isasync": false, + "name": "listNetworkPermissions", "params": [ { - "description": "the ID of the host", + "description": "Lists network permission by network ID", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" } ], - "related": "disableOutOfBandManagementForCluster", + "related": "", "response": [ { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, - { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the ID of project the network is available for", + "name": "projectid", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the project the network is available for", + "name": "project", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" }, + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the network ID", + "name": "networkid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the 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 password", - "name": "password", + "description": "the account the network is available for", + "name": "account", "type": "string" }, { @@ -106061,418 +108518,377 @@ "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the ID of the domain to which the network belongs", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the name of the domain to which the network belongs", + "name": "domain", "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" } ], - "since": "4.9.0" + "since": "4.17.0" }, { - "description": "Deletes a service offering.", + "description": "Updates Bucket properties", "isasync": false, - "name": "deleteServiceOffering", + "name": "updateBucket", "params": [ { - "description": "the ID of the service offering", + "description": "The ID of the Bucket", "length": 255, "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "related": "", "required": true, "type": "uuid" + }, + { + "description": "Bucket Quota in GB", + "length": 255, + "name": "quota", + "required": false, + "type": "integer" + }, + { + "description": "Enable/Disable Bucket Versioning", + "length": 255, + "name": "versioning", + "required": false, + "type": "boolean" + }, + { + "description": "Bucket Access Policy", + "length": 255, + "name": "policy", + "required": false, + "type": "string" + }, + { + "description": "Enable/Disable Bucket encryption", + "length": 255, + "name": "encryption", + "required": false, + "type": "boolean" } ], "response": [ - {}, { "description": "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.19.0" }, { - "description": "Lists supported Kubernetes version", + "description": "Recalculate and update resource count for an account or domain.", "isasync": false, - "name": "listKubernetesSupportedVersions", + "name": "updateResourceCount", "params": [ { - "description": "the ID of the zone in which Kubernetes supported version will be available", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the Kubernetes supported version", + "description": "Update resource limits for project", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "the minimum semantic version for the Kubernetes supported version to be listed", + "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", "length": 255, - "name": "minimumsemanticversion", - "required": false, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "resourcetype", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the minimum Kubernetes supported version", - "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": false, - "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "Name of the Kubernetes supported version", - "name": "name", - "type": "string" - }, - { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "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", + "description": "the domain name for which resource count's are updated", + "name": "domain", "type": "string" }, - { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id for which resource count's are updated", + "name": "projectid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "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 id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "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 minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "resource count", + "name": "resourcecount", + "type": "long" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, + {}, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "type": "string" }, + {}, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the project name for which resource count's are updated", + "name": "project", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" - }, - { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" } ] }, { - "description": "Updates existing email templates for quota alerts", + "description": "Lists site 2 site vpn gateways", "isasync": false, - "name": "quotaEmailTemplateUpdate", + "name": "listVpnGateways", "params": [ { - "description": "The locale of the email text", + "description": "List by keyword", "length": 255, - "name": "locale", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The quota email template subject, max: 77 characters", - "length": 77, - "name": "templatesubject", - "required": true, - "type": "string" - }, - { - "description": "The quota email template body, max: 500k characters", - "length": 512000, - "name": "templatebody", - "required": true, - "type": "string" - }, - { - "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "description": "id of the vpn gateway", "length": 255, - "name": "templatetype", - "required": true, - "type": "string" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "name": "id", + "related": "createVpnGateway,listVpnGateways", + "required": false, + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "id of vpc", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ], - "since": "4.7.0" - }, - { - "description": "Adds a Nicira NVP device", - "isasync": true, - "name": "addNiciraNvpDevice", - "params": [ - { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "transportzoneuuid", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, "type": "uuid" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "l3gatewayserviceuuid", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "l2gatewayserviceuuid", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "", + "related": "createVpnGateway", "response": [ { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the owner", + "name": "account", "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": "name of the provider", - "name": "provider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "the UUID of the latest async job acting on 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 date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" - } + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + {} ] }, { - "description": "Lists network serviceproviders for a given physical network.", + "description": "Lists dynamic roles in CloudStack", "isasync": false, - "name": "listNetworkServiceProviders", + "name": "listRoles", "params": [ { - "description": "list providers by state", + "description": "List role by role name.", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "list providers by name", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "List role by role ID.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "id", + "related": "importRole,listRoles", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -106482,81 +108898,129 @@ "type": "integer" } ], - "related": "", + "related": "importRole", "response": [ + {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the name of the role", + "name": "name", "type": "string" }, + {}, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "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": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the role", + "name": "type", + "type": "string" } ], - "since": "3.0.0" + "since": "4.9.0" }, { - "description": "delete Tungsten-Fabric tag type", - "isasync": true, - "name": "deleteTungstenFabricTagType", + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicy", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, { "description": "the ID of zone", "length": 255, "name": "zoneid", "related": "createZone,listZones", - "required": true, + "required": false, "type": "uuid" }, { - "description": "the ID of Tungsten-Fabric tag type", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "tagtypeuuid", - "required": true, + "name": "policyuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of ip address", + "length": 255, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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" } ], + "related": "", "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {}, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -106567,1699 +109031,1533 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + {} ] }, { - "description": "Lists infrastructure", - "isasync": false, - "name": "listInfrastructure", - "params": [], - "related": "", - "response": [ + "description": "Download object at a specified path on an image store.", + "isasync": true, + "name": "downloadImageStoreObject", + "params": [ { - "description": "Number of hypervisor hosts", - "name": "hosts", - "type": "integer" + "description": "path to download on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", - "type": "integer" - }, + "description": "id of the image store", + "length": 255, + "name": "id", + "related": "listSwifts,addImageStoreS3,listImageStores", + "required": true, + "type": "uuid" + } + ], + "related": "extractTemplate", + "response": [ { - "description": "Number of images stores", - "name": "imagestores", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", - "type": "integer" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "Number of systemvms", - "name": "systemvms", - "type": "integer" + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" }, { - "description": "Number of pods", - "name": "pods", - "type": "integer" + "description": "", + "name": "resultstring", + "type": "string" }, { - "description": "Number of internal LBs", - "name": "ilbvms", - "type": "integer" - }, - {}, + "description": "type of the storage", + "name": "storagetype", + "type": "string" + }, { - "description": "Number of routers", - "name": "routers", - "type": "integer" + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "Number of storage pools", - "name": "storagepools", - "type": "integer" + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Number of clusters", - "name": "clusters", - "type": "integer" + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, + { + "description": "the status of the extraction", + "name": "status", + "type": "string" }, {}, { - "description": "Number of management servers", - "name": "managementservers", - "type": "integer" + "description": "the name of the extracted object", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "type": "string" + }, + { + "description": "the id of extracted object", + "name": "id", + "type": "string" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" } ], - "since": "4.9.3" + "since": "4.19.0" }, { - "description": "Lists usage records for accounts", + "description": "Retrieves a cloud identifier.", "isasync": false, - "name": "listUsageRecords", + "name": "getCloudIdentifier", "params": [ { - "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).", + "description": "the user ID for the cloud identifier", "length": 255, - "name": "startdate", + "name": "userid", + "related": "createUser,enableUser,getUser", "required": true, - "type": "date" - }, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", - "length": 255, - "name": "usageid", - "required": false, + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" }, + {}, { - "description": "List usage records for specified project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "List usage records for the specified account", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the cloud identifier", + "name": "cloudidentifier", + "type": "string" }, + {}, { - "description": "List usage records for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the signed response for the cloud identifier", + "name": "signature", + "type": "string" }, { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", - "length": 255, - "name": "isrecursive", - "required": false, - "since": "4.15", - "type": "boolean" - }, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Creates a load balancer stickiness policy ", + "isasync": true, + "name": "createLBStickinessPolicy", + "params": [ { - "description": "", + "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "methodname", + "required": true, + "type": "string" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, - "name": "includetags", + "name": "param", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "List by keyword", + "description": "the description of the load balancer stickiness policy", "length": 255, - "name": "keyword", + "name": "description", "required": false, "type": "string" }, { - "description": "", + "description": "name of the load balancer stickiness policy", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "name", + "required": true, + "type": "string" }, { - "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", + "description": "the ID of the load balancer rule", "length": 255, - "name": "enddate", + "name": "lbruleid", + "related": "updateIpv6FirewallRule", "required": true, - "type": "date" + "type": "uuid" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "oldformat", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" - }, - { - "description": "List usage records for the specified user.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "List usage records for the specified usage type", - "length": 255, - "name": "type", - "required": false, - "type": "long" } ], - "related": "", + "related": "listLBStickinessPolicies", "response": [ + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" - }, - { - "description": "the domain ID", + "description": "the domain ID of the Stickiness policy", "name": "domainid", "type": "string" }, + {}, + {}, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the user account name", - "name": "account", - "type": "string" - }, - { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the project name of the resource", - "name": "project", - "type": "string" - }, - { - "description": "resource or virtual machine name", - "name": "name", - "type": "string" - }, - { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" - }, - { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" - }, - { - "description": "template ID", - "name": "templateid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "description of the usage record", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the resource", - "name": "usageid", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" } ], - "type": "set" - }, - { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain the resource is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "raw usage in hours", - "name": "rawusage", - "type": "string" - }, - { - "description": "True if the resource is default", - "name": "isdefault", - "type": "boolean" - }, - {}, - { - "description": "usage in hours", - "name": "usage", - "type": "string" - }, - { - "description": "start date of the usage record", - "name": "startdate", - "type": "string" - }, - { - "description": "the user account Id", - "name": "accountid", - "type": "string" + "type": "list" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "the zone ID", + "description": "the id of the zone the Stickiness policy belongs to", "name": "zoneid", "type": "string" - }, - { - "description": "id of the network", - "name": "networkid", - "type": "string" - }, - { - "description": "resource size", - "name": "size", - "type": "long" - }, - { - "description": "virtual machine os category name", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the project id of the resource", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine os display name", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "virtual machine os type ID", - "name": "ostypeid", - "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Adds a Cisco Asa 1000v appliance", + "isasync": false, + "name": "addCiscoAsa1000vResource", + "params": [ { - "description": "resource type", - "name": "type", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "offering ID", - "name": "offeringid", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the Cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" - } - ] - }, - { - "description": "Delete Netscaler Control Center", - "isasync": false, - "name": "deleteNetscalerControlCenter", - "params": [ - { - "description": "Netscaler Control Center ID", + "description": "Nexus port profile associated with inside interface of ASA 1000v", "length": 255, - "name": "id", - "related": "", + "name": "insideportprofile", "required": true, "type": "string" } ], + "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {}, + {} ] }, { - "description": "Deletes a detached disk volume.", - "isasync": false, - "name": "deleteVolume", + "description": "Configures a Palo Alto firewall device", + "isasync": true, + "name": "configurePaloAltoFirewall", "params": [ { - "description": "The ID of the disk volume", + "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "fwdevicecapacity", + "required": false, + "type": "long" + }, + { + "description": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", "required": true, "type": "uuid" } ], + "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, - {} - ] - }, - { - "description": "Recovers a Destroy volume.", - "isasync": false, - "name": "recoverVolume", - "params": [ { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - } - ], - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ + "description": "the public interface of the external firewall", + "name": "publicinterface", + "type": "string" + }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, - {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "device capacity", + "name": "fwdevicecapacity", "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "device name", + "name": "fwdevicename", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, + {}, { - "description": "the 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 private security zone of the external firewall", + "name": "privatezone", + "type": "string" + } + ] + }, + { + "description": "Updates ACL item with specified ID", + "isasync": true, + "name": "updateNetworkACLItem", + "params": [ { - "description": "ID of the disk volume", - "name": "id", + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "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": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "A description indicating why the ACL rule is required.", + "length": 255, + "name": "reason", + "required": false, "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", + "length": 255, + "name": "partialupgrade", + "required": false, + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": false, "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the ending port of ACL", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the ID of the network ACL item", + "length": 255, + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "The network of the vm the ACL will be created for", + "length": 255, + "name": "number", + "required": false, + "type": "integer" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "moveNetworkAclItem", + "response": [ + { + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, - {}, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "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", + "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": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, + {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + } + ] + }, + { + "description": "Moves a user to another account", + "isasync": false, + "name": "moveUser", + "params": [ + { + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the account associated with the disk volume", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, + "description": "id of the user to be deleted", + "length": 255, + "name": "id", + "related": "createUser,enableUser,getUser", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "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": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {} + ], + "since": "4.11" + }, + { + "description": "List routers.", + "isasync": false, + "name": "listRouters", + "params": [ { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the cluster ID of the router", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the router", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "List networks by VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "list virtual router elements by version", + "length": 255, + "name": "version", + "required": false, "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the state of the router", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "the host ID of the router", + "length": 255, + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID of the router", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the ID of the disk router", + "length": 255, + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "if true is passed for this parameter, list only VPC routers", + "length": 255, + "name": "forvpc", + "required": false, "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "length": 255, + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "remove Tungsten-Fabric network gateway from logical router", - "isasync": true, - "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", - "params": [ - { - "description": "the ID of zone", + "description": "the Pod ID of the router", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "Tungsten-Fabric logical router uuid", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "logicalrouteruuid", - "required": true, - "type": "string" + "name": "healthchecksfailed", + "required": false, + "since": "4.16", + "type": "boolean" }, { - "description": "Tungsten-Fabric network uuid", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Enables a user account", - "isasync": false, - "name": "enableUser", - "params": [ - { - "description": "Enables user by user 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": "createUser,enableUser,getUser", - "required": true, - "type": "uuid" + "name": "listall", + "required": false, + "type": "boolean" } ], - "related": "createUser,getUser", + "related": "destroyRouter", "response": [ - {}, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the user name", - "name": "username", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the type of the role", - "name": "roletype", + "description": "role of the domain router", + "name": "role", "type": "string" }, + {}, { - "description": "the account name of the user", - "name": "account", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, - {}, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "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 state of the router", + "name": "state", + "type": "state" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists zone metrics", - "isasync": false, - "name": "listZonesMetrics", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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, + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the name of the zone", - "length": 255, - "name": "name", - "required": false, + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "flag to display the capacity of the zones", - "length": 255, - "name": "showcapacities", - "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 ID of the zone", - "length": 255, - "name": "id", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the network type of the zone that the virtual machine belongs to", - "length": 255, - "name": "networktype", - "required": false, + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "flag to display the resource image for the zones", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "state of the cluster", - "name": "state", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 account associated with the tag", - "name": "account", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "healthy / total clusters in the zone", - "name": "clusters", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, - {}, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "Zone name", + "description": "the name of the router", "name": "name", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the capacity name", - "name": "name", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "result of the health check", + "name": "success", + "type": "boolean" } ], "type": "list" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, - {}, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" - }, + } + ] + }, + { + "description": "Releases host reservation.", + "isasync": true, + "name": "releaseHostReservation", + "params": [ { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the host ID", + "length": 255, + "name": "id", + "related": "reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - } - ], - "since": "4.9.3" + {} + ] }, { - "description": "Creates a quota tariff for a resource.", + "description": "list Tungsten-Fabric vm", "isasync": false, - "name": "quotaTariffCreate", + "name": "listTungstenFabricVm", "params": [ { - "description": "Quota tariff's name", - "length": 65535, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. Inform null to use the current date.", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "startdate", + "name": "vmuuid", "required": false, - "type": "date" - }, - { - "description": "Integer value for the usage type of the resource.", - "length": 255, - "name": "usagetype", - "required": true, - "type": "integer" + "type": "string" }, { - "description": "The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03.", + "description": "the ID of zone", "length": 255, - "name": "enddate", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", - "length": 65535, - "name": "activationrule", + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "The quota tariff value of the resource as per the default unit.", + "description": "", "length": 255, - "name": "value", - "required": true, - "type": "double" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Quota tariff's description.", - "length": 65535, - "name": "description", + "description": "", + "length": 255, + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "uuid", + "description": "Tungsten-Fabric nic uuid", "name": "uuid", "type": "string" }, { - "description": "currency", - "name": "currency", - "type": "string" - }, - { - "description": "usageName", - "name": "usageName", - "type": "string" - }, - { - "description": "usageUnit", - "name": "usageUnit", - "type": "string" - }, - { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, + {}, { - "description": "description", - "name": "description", + "description": "Tungsten-Fabric vm name", + "name": "name", "type": "string" }, { @@ -108268,118 +110566,85 @@ "type": "integer" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" - }, - { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" - }, - { - "description": "activation rule of the quota tariff", - "name": "activationRule", - "type": "string" - }, - { - "description": "usage type description", - "name": "usageTypeDescription", - "type": "string" - }, - {}, - {}, - { - "description": "usageType", - "name": "usageType", - "type": "int" - }, - { - "description": "name", - "name": "name", - "type": "string" } - ], - "since": "4.18.0.0" + ] }, { - "description": "Extracts a template", + "description": "Create site to site vpn connection", "isasync": true, - "name": "extractTemplate", + "name": "createVpnConnection", "params": [ { - "description": "the ID of the template", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the zone where the ISO is originally located", + "description": "id of the customer gateway", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, + "name": "s2scustomergatewayid", + "related": "createVpnCustomerGateway", + "required": true, "type": "uuid" }, { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" + "description": "id of the vpn gateway", + "length": 255, + "name": "s2svpngatewayid", + "related": "createVpnGateway", + "required": true, + "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "connection is passive or not", "length": 255, - "name": "mode", - "required": true, - "type": "string" + "name": "passive", + "required": false, + "type": "boolean" } ], "related": "", "response": [ {}, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the public IP address", + "name": "publicip", + "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, { @@ -108388,81 +110653,79 @@ "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "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": "the state of the extracted object", + "description": "State of vpn connection", "name": "state", "type": "string" }, + {}, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "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 mode of extraction - upload or download", - "name": "extractMode", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" - } - ] - }, - { - "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", - "isasync": true, - "name": "expungeVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "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", + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -108471,247 +110734,284 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, - {} + { + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + } ] }, { - "description": "Suspends a project", - "isasync": true, - "name": "suspendProject", + "description": "lists network that are using a brocade vcs switch", + "isasync": false, + "name": "listBrocadeVcsDeviceNetworks", "params": [ { - "description": "id of the project to be suspended", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "activateProject,suspendProject", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "brocade vcs switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "activateProject", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", + "description": "the list of services", + "name": "service", "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability 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 domain associated with the tag", - "name": "domain", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "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 volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the project name of the address", + "name": "project", "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", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "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", @@ -108719,429 +111019,313 @@ "type": "integer" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the date this project was created", + "description": "the date this network was created", "name": "created", "type": "date" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates an IP address", - "isasync": true, - "name": "updateIpAddress", - "params": [ - { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "the ID of the public IP address to update", - "length": 255, - "name": "id", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "related": "associateIpAddress,listPublicIpAddresses", - "response": [ - { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, - {}, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, + {}, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "the name of the zone the public IP address 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": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "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 name of the zone the network belongs to", + "name": "zonename", "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": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "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": "is public IP portable across the zones", - "name": "isportable", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the network's gateway", + "name": "gateway", "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 name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "public IP address id", - "name": "id", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Get API limit count for the caller", - "isasync": false, - "name": "getApiLimit", - "params": [], - "related": "", - "response": [ - { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the account name of the api remaining count", + "description": "the owner of the network", "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the network", + "name": "id", "type": "string" }, - {}, { - "description": "the account uuid of the api remaining count", - "name": "accountid", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, {} ] }, { - "description": "Deletes a storage network IP Range.", + "description": "Deletes a Physical Network.", "isasync": true, - "name": "deleteStorageNetworkIpRange", + "name": "deletePhysicalNetwork", "params": [ { - "description": "the uuid of the storage network ip range", + "description": "the ID of the Physical network", "length": 255, "name": "id", - "related": "createStorageNetworkIpRange", + "related": "createPhysicalNetwork", "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": "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", @@ -109151,586 +111335,637 @@ "since": "3.0.0" }, { - "description": "moves a network to another physical network", + "description": "add Tungsten-Fabric policy rule", "isasync": true, - "name": "migrateNetwork", + "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "the ID of the network", + "description": "Tungsten-Fabric policy rule source ip prefix length", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "srcipprefixlen", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "true if previous network migration cmd failed", + "description": "Tungsten-Fabric policy rule destination end port", "length": 255, - "name": "resume", - "required": false, - "type": "boolean" + "name": "destendport", + "required": true, + "type": "integer" }, { - "description": "network offering ID", + "description": "Tungsten-Fabric policy rule source end port", "length": 255, - "name": "networkofferingid", - "related": "", + "name": "srcendport", "required": true, - "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,listNetworks", - "response": [ + "type": "integer" + }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Tungsten-Fabric policy rule source ip prefix", + "length": 255, + "name": "srcipprefix", + "required": true, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy rule action", + "length": 255, + "name": "action", + "required": true, "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric policy rule destination start port", + "length": 255, + "name": "deststartport", + "required": true, + "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Tungsten-Fabric policy rule source network", + "length": 255, + "name": "srcnetwork", + "required": true, + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "Tungsten-Fabric policy rule source start port", + "length": 255, + "name": "srcstartport", + "required": true, + "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "Tungsten-Fabric policy rule direction", + "length": 255, + "name": "direction", + "required": true, "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "Tungsten-Fabric policy rule destination ip prefix length", + "length": 255, + "name": "destipprefixlen", + "required": true, + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Tungsten-Fabric policy rule protocol", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, - {}, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "Tungsten-Fabric policy rule destination network", + "length": 255, + "name": "destnetwork", + "required": true, + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, + "description": "Tungsten-Fabric policy rule destination ip prefix", + "length": 255, + "name": "destipprefix", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the network domain", - "name": "networkdomain", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + {}, + { + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, + {}, { - "description": "the id of the network", - "name": "id", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "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 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": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" + } + ] + }, + { + "description": "Dedicates a host.", + "isasync": true, + "name": "dedicateHost", + "params": [ + { + "description": "the ID of the host to update", + "length": 255, + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "listDedicatedHosts", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, + {}, + {}, { - "description": "the network's gateway", - "name": "gateway", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the name of the host", + "name": "hostname", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "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 ID of the dedicated resource", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Removes vpn user", + "isasync": true, + "name": "removeVpnUser", + "params": [ { - "description": "zone id of the network", - "name": "zoneid", + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "username for the vpn user", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, + "description": "remove vpn user from the project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + } + ], + "response": [ { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Adds the GloboDNS external host", + "isasync": true, + "name": "addGloboDnsHost", + "params": [ { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Username for GloboDNS", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "Password for GloboDNS", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "GloboDNS url", + "length": 255, + "name": "url", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.5.0" + }, + { + "description": "List public IP addresses in quarantine.", + "isasync": false, + "name": "listQuarantinedIps", + "params": [ { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "Show IPs that are no longer in quarantine.", + "length": 255, + "name": "showinactive", + "required": false, "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Show IPs removed from quarantine.", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" + } + ], + "related": "updateQuarantinedIp", + "response": [ + {}, + { + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "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": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "4.19" + }, + { + "description": "Logs out the user", + "isasync": false, + "name": "logout", + "params": [], + "related": "", + "response": [ + {}, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Response description", + "name": "description", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a load balancer health check policy.", + "isasync": true, + "name": "deleteLBHealthCheckPolicy", + "params": [ { - "description": "the name of the network", - "name": "name", - "type": "string" - }, + "description": "the ID of the load balancer health check policy", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "The external id of the network", - "name": "externalid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "state of the network", - "name": "state", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], - "since": "4.11.0" + "since": "4.2.0" }, { - "description": "configures simulator HA provider state for a host for probing and testing", + "description": "Imports a role based on provided map of rule permissions", "isasync": false, - "name": "configureSimulatorHAProviderState", + "name": "importRole", "params": [ { - "description": "Set true is haprovider for simulator host should be be recoverable", + "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": "recover", - "required": true, + "name": "forced", + "required": false, "type": "boolean" }, { - "description": "Set true is haprovider for simulator host should be be fence-able", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "fence", - "required": true, - "type": "boolean" + "name": "type", + "required": false, + "type": "string" }, { - "description": "Set true is haprovider for simulator host should be healthy", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "length": 255, - "name": "health", - "required": true, + "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "Set true is haprovider for simulator host should have activity", + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", "length": 255, - "name": "activity", + "name": "rules", "required": true, - "type": "boolean" + "type": "map" }, { - "description": "List by host ID", + "description": "Creates a role with this unique name", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "name", "required": true, - "type": "uuid" + "type": "string" } ], + "related": "", "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if role is default, false otherwise", + "name": "isdefault", "type": "boolean" }, {}, @@ -109739,264 +111974,350 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, + { + "description": "the type of the role", + "name": "type", + "type": "string" + }, + { + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" } ], - "since": "4.11" + "since": "4.15.0" }, { - "description": "Updates Ipv6 firewall rule with specified ID", - "isasync": true, - "name": "updateIpv6FirewallRule", + "description": "List Swift.", + "isasync": false, + "name": "listSwifts", "params": [ { - "description": "the ending port of Ipv6 firewall rule", + "description": "the id of the swift", "length": 255, - "name": "endport", + "name": "id", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "", "length": 255, - "name": "protocol", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "List by keyword", "length": 255, - "name": "traffictype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "error code for this ICMP message", + "description": "", "length": 255, - "name": "icmpcode", + "name": "page", "required": false, "type": "integer" + } + ], + "related": "addImageStoreS3,listImageStores", + "response": [ + { + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", - "length": 255, - "name": "startport", - "required": false, + "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 current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the ipv6 firewall rule", + "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": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", + "params": [ + { + "description": "ID of the host", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, { - "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "list" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, + {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "Enables out-of-band management for a host", + "isasync": true, + "name": "enableOutOfBandManagementForHost", + "params": [ + { + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "disableOutOfBandManagementForCluster", + "response": [ + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the operation result description", + "name": "description", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Deletes a service offering.", + "isasync": false, + "name": "deleteServiceOffering", + "params": [ + { + "description": "the ID of the service offering", + "length": 255, + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Lists unmanaged virtual machines for a given cluster.", + "description": "Lists supported Kubernetes version", "isasync": false, - "name": "listUnmanagedInstances", + "name": "listKubernetesSupportedVersions", "params": [ { - "description": "", + "description": "the minimum semantic version for the Kubernetes supported version to be listed", "length": 255, - "name": "pagesize", + "name": "minimumsemanticversion", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the cluster ID", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, "type": "uuid" }, { @@ -110014,358 +112335,355 @@ "type": "string" }, { - "description": "the hypervisor name of the instance", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "name", + "name": "id", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the ID of the minimum Kubernetes supported version", + "length": 255, + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - } - ], - "type": "set" + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + {}, {}, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + } + ] + }, + { + "description": "Adds a Nicira NVP device", + "isasync": true, + "name": "addNiciraNvpDevice", + "params": [ + { + "description": "Hostname of ip address of the Nicira NVP Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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": "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" + "description": "The Transportzone UUID configured on the Nicira Controller", + "length": 255, + "name": "transportzoneuuid", + "required": true, + "type": "string" + }, + { + "description": "Credentials to access the Nicira 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" + }, + { + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l2gatewayserviceuuid", + "required": false, + "type": "string" + }, + { + "description": "Credentials to access the Nicira Controller API", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l3gatewayserviceuuid", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the transport zone Uuid", + "name": "transportzoneuuid", + "type": "string" + }, + { + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", + "type": "string" + }, + { + "description": "device name", + "name": "niciradevicename", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the controller Ip address", + "name": "hostname", + "type": "string" + }, + { + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", + "type": "string" + }, + { + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "4.14.0" + ] }, { - "description": "Updates ISO permissions", + "description": "Lists network serviceproviders for a given physical network.", "isasync": false, - "name": "updateIsoPermissions", + "name": "listNetworkServiceProviders", "params": [ { - "description": "true for public template/iso, false for private templates/isos", + "description": "", "length": 255, - "name": "ispublic", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "List by keyword", "length": 255, - "name": "projectids", - "related": "activateProject", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "list providers by name", "length": 255, - "name": "accounts", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "the template ID", + "description": "", "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "the Physical Network ID", "length": 255, - "name": "isextractable", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true for featured template/iso, false otherwise", + "description": "list providers by state", "length": 255, - "name": "isfeatured", + "name": "state", "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "description": "permission operator (add, remove, reset)", + "description": "the UUID of the latest async job acting on 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", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + {}, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + {} + ], + "since": "3.0.0" + }, + { + "description": "delete Tungsten-Fabric tag type", + "isasync": true, + "name": "deleteTungstenFabricTagType", + "params": [ + { + "description": "the ID of zone", "length": 255, - "name": "op", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": true, "type": "string" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -110376,6 +112694,7 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -110390,409 +112709,382 @@ ] }, { - "description": "Registers an existing template into the CloudStack cloud.", + "description": "Lists infrastructure", "isasync": false, - "name": "registerTemplate", - "params": [ + "name": "listInfrastructure", + "params": [], + "related": "", + "response": [ { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "description": "Number of object stores", + "name": "objectstores", + "type": "integer" }, + {}, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "Number of clusters", + "name": "clusters", + "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": "Number of cpu sockets", + "name": "cpusockets", + "type": "integer" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "Number of hypervisor hosts", + "name": "hosts", + "type": "integer" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template is available to all accounts; default is true", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" + "description": "Number of storage pools", + "name": "storagepools", + "type": "integer" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "Number of Alerts", + "name": "alerts", + "type": "integer" }, + {}, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", - "length": 255, - "name": "zoneids", - "related": "createZone,listZones", - "required": false, - "type": "list" + "description": "Number of management servers", + "name": "managementservers", + "type": "integer" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "Number of internal LBs", + "name": "ilbvms", + "type": "integer" + }, + { + "description": "Number of routers", + "name": "routers", + "type": "integer" + }, + { + "description": "Number of zones", + "name": "zones", + "type": "integer" + }, + { + "description": "Number of systemvms", + "name": "systemvms", + "type": "integer" + }, + { + "description": "Number of pods", + "name": "pods", + "type": "integer" + } + ], + "since": "4.9.3" + }, + { + "description": "Lists usage records for accounts", + "isasync": false, + "name": "listUsageRecords", + "params": [ + { + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "directdownload", + "name": "oldformat", "required": false, "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "isdynamicallyscalable", + "name": "usageid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "startdate", + "required": true, + "type": "date" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "List usage records for specified project", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "the name of the template", + "description": "List usage records for the specified user.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "List usage records for the specified usage type", "length": 255, - "name": "passwordenabled", + "name": "type", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "List usage records for the specified domain.", "length": 255, - "name": "bits", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "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": "isrouting", + "name": "isrecursive", "required": false, + "since": "4.15", "type": "boolean" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "details", + "name": "includetags", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "Register template for the project", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "List usage records for the specified account", "length": 255, - "name": "isextractable", + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "List by keyword", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if this template requires HVM", + "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": "requireshvm", - "required": false, - "type": "boolean" + "name": "enddate", + "required": true, + "type": "date" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "", "response": [ { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "usage type ID", + "name": "usagetype", "type": "integer" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "end date of the usage record", + "name": "enddate", "type": "string" }, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "start date of the usage record", + "name": "startdate", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the user account name", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" }, - {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "template ID", + "name": "templateid", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", + "description": "the domain ID", "name": "domainid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "usage in hours", + "name": "usage", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the resource", + "name": "project", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "resource type", + "name": "type", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the project id of the resource", + "name": "projectid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "number of cpu of resource", + "name": "cpunumber", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" }, { - "description": "the account id to which the template belongs", + "description": "the user account Id", "name": "accountid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "description of the usage record", + "name": "description", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "raw usage in hours", + "name": "rawusage", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "resource size", + "name": "size", + "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "id of the resource", + "name": "usageid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "id of the network", + "name": "networkid", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the domain the resource is associated with", + "name": "domain", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "offering ID", + "name": "offeringid", "type": "string" }, - {}, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "virtual machine os display name", + "name": "osdisplayname", "type": "string" }, { @@ -110800,28 +113092,28 @@ "name": "tags", "response": [ { - "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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" }, { @@ -110830,8 +113122,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -110845,81 +113137,30 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "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 size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" } ] }, { - "description": "Deletes VPC offering", - "isasync": true, - "name": "deleteVPCOffering", + "description": "Deletes an Object Storage Pool", + "isasync": false, + "name": "deleteObjectStoragePool", "params": [ { - "description": "the ID of the VPC offering", + "description": "The Object Storage ID.", "length": 255, "name": "id", - "related": "updateVPCOffering", + "related": "", "required": true, "type": "uuid" } ], "response": [ - {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -110932,72 +113173,37 @@ "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] + }, + {} + ], + "since": "4.19.0" }, { - "description": "list recent simulator HA state transitions for a host for probing and testing", + "description": "Delete Netscaler Control Center", "isasync": false, - "name": "listSimulatorHAStateTransitions", + "name": "deleteNetscalerControlCenter", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by host ID", + "description": "Netscaler Control Center ID", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "id", + "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": "", "response": [ { - "description": "the activity counter", - "name": "activitycounter", - "type": "long" - }, - { - "description": "the event that caused state transition", - "name": "event", - "type": "string" - }, - { - "description": "the previous ha state", - "name": "prevhastate", - "type": "string" - }, - { - "description": "the ha state", - "name": "hastate", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -111007,9 +113213,9 @@ }, {}, { - "description": "the recovery counter", - "name": "recoverycounter", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -111017,69 +113223,29 @@ "type": "integer" }, {} - ], - "since": "4.11" + ] }, { - "description": "Adds stratosphere ssp server", + "description": "Deletes a detached disk volume.", "isasync": false, - "name": "addStratosphereSsp", + "name": "deleteVolume", "params": [ { - "description": "stratosphere ssp server url", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "stratosphere ssp api name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the zone ID", + "description": "The ID of the disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" - }, - { - "description": "stratosphere ssp tenant uuid", - "length": 255, - "name": "tenantuuid", - "required": false, - "type": "string" - }, - { - "description": "stratosphere ssp api username", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "stratosphere ssp api password", - "length": 255, - "name": "password", - "required": false, - "type": "string" } ], - "related": "", "response": [ + {}, + {}, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", - "type": "string" - }, - { - "description": "zone which this ssp controls", - "name": "zoneid", - "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", @@ -111087,675 +113253,999 @@ "type": "string" }, { - "description": "name", - "name": "name", - "type": "string" - }, - {}, - { - "description": "url of ssp endpoint", - "name": "url", + "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 a network ACL", - "isasync": true, - "name": "deleteNetworkACL", + "description": "Recovers a Destroy volume.", + "isasync": false, + "name": "recoverVolume", "params": [ { - "description": "the ID of the network ACL", + "description": "The ID of the volume", "length": 255, "name": "id", - "related": "moveNetworkAclItem", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" } ], + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the disk volume", + "name": "id", "type": "string" - } - ] - }, - { - "description": "Creates a storage pool.", - "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": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name for the storage pool", - "length": 255, - "name": "name", - "required": true, + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the storage provider name", - "length": 255, - "name": "provider", - "required": false, + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the cluster ID for the storage pool", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the details for the storage pool", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "whether the storage should be managed by CloudStack", - "length": 255, - "name": "managed", - "required": false, + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the URL of the storage pool", - "length": 255, - "name": "url", - "required": true, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "length": 255, - "name": "capacityiops", - "required": false, - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the scope of the storage: cluster or zone", - "length": 255, - "name": "scope", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" - } - ], - "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", - "response": [ + }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, - {}, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the date and time the storage pool was created", + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "the storage pool path", - "name": "path", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 total disk size of the storage pool", - "name": "disksizetotal", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + {}, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" } - ] + ], + "since": "4.14.0" }, { - "description": "Lists storage pools available for migration of a volume.", - "isasync": false, - "name": "findStoragePoolsForMigration", + "description": "remove Tungsten-Fabric network gateway from logical router", + "isasync": true, + "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ { - "description": "the ID of the volume", + "description": "Tungsten-Fabric network uuid", "length": 255, - "name": "id", - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "networkuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" }, { - "description": "", + "description": "Tungsten-Fabric logical router uuid", "length": 255, - "name": "pagesize", - "required": false, + "name": "logicalrouteruuid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "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 name", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + {} + ] + }, + { + "description": "Updates an existing secondary storage selector.", + "isasync": false, + "name": "updateSecondaryStorageSelector", + "params": [ + { + "description": "The unique identifier of the secondary storage selector.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", + "required": true, + "type": "uuid" + }, + { + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" } ], - "related": "cancelStorageMaintenance,enableStorageMaintenance", + "related": "removeSecondaryStorageSelector", "response": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Description of the heuristic.", + "name": "description", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "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": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, + {}, { - "description": "the date and time the storage pool was created", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Enables a user account", + "isasync": false, + "name": "enableUser", + "params": [ + { + "description": "Enables user by user ID.", + "length": 255, + "name": "id", + "related": "createUser,enableUser,getUser", + "required": true, + "type": "uuid" + } + ], + "related": "createUser,getUser", + "response": [ + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "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 api key of the user", + "name": "apikey", + "type": "string" + }, { - "description": "the ID of the storage pool", + "description": "the user ID", "name": "id", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + {}, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the user name", + "name": "username", "type": "string" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "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 type of the role", + "name": "roletype", + "type": "string" } ] }, { - "description": "create Tungsten-Fabric tag", - "isasync": true, - "name": "createTungstenFabricTag", + "description": "Lists zone metrics", + "isasync": false, + "name": "listZonesMetrics", "params": [ { - "description": "Tungsten-Fabric tag type", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "tagtype", - "required": true, - "type": "string" + "name": "ids", + "related": "createZone,listZones", + "required": false, + "since": "4.19.0", + "type": "list" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "id", "related": "createZone,listZones", - "required": true, + "required": false, "type": "uuid" }, { - "description": "Tungsten-Fabric tag value", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "tagvalue", - "required": true, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, + "type": "string" + }, + { + "description": "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" + }, + { + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the zone", + "length": 255, + "name": "name", + "required": false, "type": "string" } ], "related": "", "response": [ - {}, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "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": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "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 display text of the zone", + "name": "displaytext", "type": "string" - } - ] - }, - { - "description": "Adds an OpenDyalight controler", - "isasync": true, - "name": "addOpenDaylightController", - "params": [ + }, { - "description": "Username to access the OpenDaylight API", - "length": 255, - "name": "username", - "required": true, + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "Credential to access the OpenDaylight API", - "length": 255, - "name": "password", - "required": true, + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "Api URL of the OpenDaylight Controller.", - "length": 255, - "name": "url", - "required": true, + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, - {}, { - "description": "device id of the controller", - "name": "id", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the name assigned to the controller", + "description": "Zone name", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone id", + "name": "id", + "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" - } - ] - }, - { - "description": "delete Tungsten-Fabric firewall rule", - "isasync": true, - "name": "deleteTungstenFabricFirewallRule", - "params": [ + }, + {}, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "Zone Token", + "name": "zonetoken", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", - "length": 255, - "name": "firewallruleuuid", - "required": true, + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "healthy / total clusters in the zone", + "name": "clusters", + "type": "string" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { @@ -111763,453 +114253,6192 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "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": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "state of the cluster", + "name": "state", + "type": "string" + } + ], + "since": "4.9.3" + }, + { + "description": "Extracts a template", + "isasync": true, + "name": "extractTemplate", + "params": [ + { + "description": "the ID of the zone where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" + }, + { + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "type": "string" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the id of extracted object", + "name": "id", + "type": "string" + }, + { + "description": "", + "name": "resultstring", + "type": "string" + }, + {}, + { + "description": "the status of the extraction", + "name": "status", + "type": "string" + }, + { + "description": "type of the storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" + }, + { + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + } + ] + }, + { + "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", + "isasync": true, + "name": "expungeVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if 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": "Suspends a project", + "isasync": true, + "name": "suspendProject", + "params": [ + { + "description": "id of the project to be suspended", + "length": 255, + "name": "id", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" + } + ], + "related": "activateProject", + "response": [ + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "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", + "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 name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + {}, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "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 snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates an IP address", + "isasync": true, + "name": "updateIpAddress", + "params": [ + { + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the public IP address to update", + "length": 255, + "name": "id", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "related": "associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "virtual machine id the ip address is assigned to", + "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", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + {}, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, + { + "description": "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": "public IP address id", + "name": "id", + "type": "string" + }, + {}, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "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": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + } + ] + }, + { + "description": "Get API limit count for the caller", + "isasync": false, + "name": "getApiLimit", + "params": [], + "related": "", + "response": [ + { + "description": "the account uuid of the api remaining count", + "name": "accountid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" + }, + {}, + { + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" + }, + { + "description": "the account name of the api remaining count", + "name": "account", + "type": "string" + }, + { + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes a storage network IP Range.", + "isasync": true, + "name": "deleteStorageNetworkIpRange", + "params": [ + { + "description": "the uuid of the storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting 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" + }, + { + "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": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" + } + ], + "related": "createNetwork,updateNetwork,listNetworks", + "response": [ + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + {}, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the 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" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "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 list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "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": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "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": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "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 second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Adds a VMware datacenter to specified zone", + "isasync": false, + "name": "addVmwareDc", + "params": [ + { + "description": "The Zone ID.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": true, + "type": "string" + }, + { + "description": "The password for specified username.", + "length": 255, + "name": "password", + "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 Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" + }, + { + "description": "The VMware Datacenter name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "Updates Ipv6 firewall rule with specified ID", + "isasync": true, + "name": "updateIpv6FirewallRule", + "params": [ + { + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "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 ipv6 firewall rule", + "length": 255, + "name": "id", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "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": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "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 starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + {}, + {}, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the 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": "Lists unmanaged virtual machines for a given cluster.", + "isasync": false, + "name": "listUnmanagedInstances", + "params": [ + { + "description": "the hypervisor name of the instance", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + {} + ], + "since": "4.14.0" + }, + { + "description": "Updates ISO permissions", + "isasync": false, + "name": "updateIsoPermissions", + "params": [ + { + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "activateProject", + "required": false, + "type": "list" + }, + { + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" + }, + { + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, + "type": "string" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Registers an existing template into the CloudStack cloud.", + "isasync": false, + "name": "registerTemplate", + "params": [ + { + "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "length": 255, + "name": "zoneids", + "related": "createZone,listZones", + "required": false, + "type": "list" + }, + { + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "32 or 64 bits support. 64 by default", + "length": 255, + "name": "bits", + "required": false, + "type": "integer" + }, + { + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "the name of the template", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "Register template for the project", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" + }, + { + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the zone the template is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "length": 255, + "name": "deployasis", + "required": false, + "since": "4.15.1", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" + }, + { + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", + "required": true, + "type": "string" + }, + { + "description": "true if the template is available to all accounts; default is true", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + } + ], + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the template ID", + "name": "id", + "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": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + {}, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the 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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "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": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes VPC offering", + "isasync": true, + "name": "deleteVPCOffering", + "params": [ + { + "description": "the ID of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ] + }, + { + "description": "Adds stratosphere ssp server", + "isasync": false, + "name": "addStratosphereSsp", + "params": [ + { + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "stratosphere ssp tenant uuid", + "length": 255, + "name": "tenantuuid", + "required": false, + "type": "string" + }, + { + "description": "stratosphere ssp api password", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "stratosphere ssp server url", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "stratosphere ssp api name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "url of ssp endpoint", + "name": "url", + "type": "string" + }, + { + "description": "zone which this ssp controls", + "name": "zoneid", + "type": "string" + }, + { + "description": "server id of the stratosphere ssp server", + "name": "hostid", + "type": "string" + }, + { + "description": "name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Deletes a network ACL", + "isasync": true, + "name": "deleteNetworkACL", + "params": [ + { + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "moveNetworkAclItem", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Creates a storage pool.", + "isasync": false, + "name": "createStoragePool", + "params": [ + { + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "the name for the storage pool", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the details for the storage pool", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the cluster ID for the storage pool", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, + { + "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" + }, + { + "description": "bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" + }, + { + "description": "the Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the scope of the storage: cluster or zone", + "length": 255, + "name": "scope", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the URL of the storage pool", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "whether the storage should be managed by CloudStack", + "length": 255, + "name": "managed", + "required": false, + "type": "boolean" + }, + { + "description": "the storage provider name", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + } + ], + "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", + "response": [ + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + {}, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + {}, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + } + ] + }, + { + "description": "Lists storage pools available for migration of a volume.", + "isasync": false, + "name": "findStoragePoolsForMigration", + "params": [ + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "cancelStorageMaintenance,enableStorageMaintenance", + "response": [ + { + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "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 name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + {}, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "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": "create Tungsten-Fabric tag", + "isasync": true, + "name": "createTungstenFabricTag", + "params": [ + { + "description": "Tungsten-Fabric tag type", + "length": 255, + "name": "tagtype", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric tag value", + "length": 255, + "name": "tagvalue", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, + {}, + { + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" + } + ] + }, + { + "description": "Adds an OpenDyalight controler", + "isasync": true, + "name": "addOpenDaylightController", + "params": [ + { + "description": "Username to access the OpenDaylight API", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "Credential to access the OpenDaylight API", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "Api URL of the OpenDaylight Controller.", + "length": 255, + "name": "url", + "required": true, + "type": "string" + } + ], + "related": "", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the url of the controller api", + "name": "url", + "type": "string" + }, + { + "description": "the username to authenticate to the controller", + "name": "username", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "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" + }, + { + "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": "Creates a Zone.", + "isasync": false, + "name": "createZone", + "params": [ + { + "description": "true if the zone is an edge zone, false otherwise", + "length": 255, + "name": "isedge", + "required": false, + "since": "4.18.0", + "type": "boolean" + }, + { + "description": "the first DNS for the Zone", + "length": 255, + "name": "dns1", + "required": true, + "type": "string" + }, + { + "description": "Allocation state of this Zone for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "network type of the zone, can be Basic or Advanced", + "length": 255, + "name": "networktype", + "required": true, + "type": "string" + }, + { + "description": "the name of the Zone", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "the second DNS for the Zone", + "length": 255, + "name": "dns2", + "required": false, + "type": "string" + }, + { + "description": "the ID of the containing domain, null for public zones", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "true if network is security group enabled, false otherwise", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the first internal DNS for the Zone", + "length": 255, + "name": "internaldns1", + "required": true, + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "length": 255, + "name": "localstorageenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the guest CIDR address for the Zone", + "length": 255, + "name": "guestcidraddress", + "required": false, + "type": "string" + }, + { + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", + "required": false, + "type": "string" + }, + { + "description": "the second internal DNS for the Zone", + "length": 255, + "name": "internaldns2", + "required": false, + "type": "string" + }, + { + "description": "the second DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns2", + "required": false, + "type": "string" + } + ], + "related": "listZones", + "response": [ + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "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 type of the zone - core or edge", + "name": "type", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + {}, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + } + ], + "type": "list" + }, + {}, + { + "description": "the 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": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "Zone name", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + } + ] + }, + { + "description": "disable a Cisco Nexus VSM device", + "isasync": true, + "name": "disableCiscoNexusVSM", + "params": [ + { + "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", + "length": 255, + "name": "id", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", + "required": true, + "type": "uuid" + } + ], + "related": "listCiscoNexusVSMs", + "response": [ + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, + { + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" + }, + { + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", + "type": "string" + }, + { + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" + }, + {}, + { + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" + }, + { + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, + { + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device state", + "name": "vsmdevicestate", + "type": "string" + }, + {}, + { + "description": "device name", + "name": "vsmdevicename", + "type": "string" + }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + } + ] + }, + { + "description": "Creates a Storage network IP range.", + "isasync": true, + "name": "createStorageNetworkIpRange", + "params": [ + { + "description": "the gateway for storage network", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" + }, + { + "description": "the ending IP address", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + }, + { + "description": "the beginning IP address", + "length": 255, + "name": "startip", + "required": true, + "type": "string" + }, + { + "description": "UUID of pod where the ip range belongs to", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "length": 255, + "name": "vlan", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the netmask of the storage network IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + }, + { + "description": "the 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" + }, + { + "description": "the Pod uuid for the storage network IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" + }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Lists all children domains belonging to a specified domain", + "isasync": false, + "name": "listDomainChildren", + "params": [ + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list children domains by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list children domain by parent domain ID.", + "length": 255, + "name": "id", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "listDomains", + "response": [ + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + {}, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + {}, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + } + ] + }, + { + "description": "Returns an encrypted password for the VM", + "isasync": false, + "name": "getVMPassword", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "The base64 encoded encrypted password of the VM", + "name": "encryptedpassword", + "type": "string" + } + ] + }, + { + "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", + "isasync": true, + "name": "assignToGlobalLoadBalancerRule", + "params": [ + { + "description": "the list load balancer rules that will be assigned to global load balancer rule", + "length": 255, + "name": "loadbalancerrulelist", + "related": "", + "required": true, + "type": "list" + }, + { + "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "length": 255, + "name": "gslblbruleweightsmap", + "required": false, + "type": "map" + }, + { + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "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": "Configures an ovs element.", + "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, + "name": "id", + "related": "configureOvsElement", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the id of the ovs", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, + { + "description": "the account associated with the provider", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + {} + ] + }, + { + "description": "Adds S3 Image Store", + "isasync": false, + "name": "addImageStoreS3", + "params": [ + { + "description": "S3 secret key", + "length": 255, + "name": "secretkey", + "required": true, + "type": "string" + }, + { + "description": "Connection TTL (milliseconds)", + "length": 255, + "name": "connectionttl", + "required": false, + "type": "integer" + }, + { + "description": "Connection timeout (milliseconds)", + "length": 255, + "name": "connectiontimeout", + "required": false, + "type": "integer" + }, + { + "description": "Whether TCP keep-alive is used", + "length": 255, + "name": "usetcpkeepalive", + "required": false, + "type": "boolean" + }, + { + "description": "S3 endpoint", + "length": 255, + "name": "endpoint", + "required": true, + "type": "string" + }, + { + "description": "Use HTTPS instead of HTTP", + "length": 255, + "name": "usehttps", + "required": false, + "type": "boolean" + }, + { + "description": "Maximum number of times to retry on error", + "length": 255, + "name": "maxerrorretry", + "required": false, + "type": "integer" + }, + { + "description": "S3 access key", + "length": 255, + "name": "accesskey", + "required": true, + "type": "string" + }, + { + "description": "Name of the storage bucket", + "length": 255, + "name": "bucket", + "required": true, + "type": "string" + }, + { + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "length": 255, + "name": "s3signer", + "required": false, + "type": "string" + }, + { + "description": "Socket timeout (milliseconds)", + "length": 255, + "name": "sockettimeout", + "required": false, + "type": "integer" + } + ], + "related": "listImageStores", + "response": [ + {}, + { + "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 Zone name of the image store", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "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 scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + } + ], + "since": "4.7.0" + }, + { + "description": "Upload a certificate for HTTPS direct template download on KVM hosts", + "isasync": false, + "name": "uploadTemplateDirectDownloadCertificate", + "params": [ + { + "description": "Hypervisor type", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "(optional) the host ID to upload certificate", + "length": 255, + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "SSL certificate", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" + }, + { + "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 issuer", + "name": "issuer", + "type": "string" + }, + { + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", + "type": "string" + }, + { + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + }, + {}, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" + }, + { + "description": "the direct download certificate version", + "name": "version", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" + }, + { + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" + }, + { + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Import unmanaged virtual machine from a given cluster.", + "isasync": true, + "name": "importUnmanagedInstance", + "params": [ + { + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "length": 255, + "name": "migrateallowed", + "required": false, + "type": "boolean" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the host name of the instance", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, + { + "description": "the name of the instance as it is known to the hypervisor", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the display name of the instance", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", + "required": false, + "type": "map" + }, + { + "description": "VM nic to network id mapping using keys nic and network", + "length": 255, + "name": "nicnetworklist", + "required": false, + "type": "map" + }, + { + "description": "import instance for the project", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" + }, + { + "description": "used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "type": "map" + }, + { + "description": "import instance to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "response": [ + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the 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 ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the 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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Creates a Zone.", - "isasync": false, - "name": "createZone", - "params": [ - { - "description": "the first internal DNS for the Zone", - "length": 255, - "name": "internaldns1", - "required": true, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", - "length": 255, - "name": "networktype", - "required": true, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the second DNS for the Zone", - "length": 255, - "name": "dns2", - "required": false, + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "length": 255, - "name": "internaldns2", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the Zone", - "length": 255, - "name": "name", - "required": true, + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "length": 255, - "name": "localstorageenabled", - "required": false, - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the second DNS for IPv6 network in the Zone", - "length": 255, - "name": "ip6dns2", - "required": false, + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "length": 255, - "name": "guestcidraddress", - "required": false, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "length": 255, - "name": "domain", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if the zone is an edge zone, false otherwise", - "length": 255, - "name": "isedge", - "required": false, - "since": "4.18.0", - "type": "boolean" - }, - { - "description": "the first DNS for IPv6 network in the Zone", - "length": 255, - "name": "ip6dns1", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the containing domain, null for public zones", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "true if network is security group enabled, false otherwise", - "length": 255, - "name": "securitygroupenabled", - "required": false, - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the first DNS for the Zone", - "length": 255, - "name": "dns1", - "required": true, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Allocation state of this Zone for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - } - ], - "related": "listZones", - "response": [ - { - "description": "the list of resource tags associated with zone.", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the 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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - {}, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, + {}, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, + {}, { - "description": "Zone name", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, - {}, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - } - ], - "type": "list" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + {}, + { + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" } - ] + ], + "since": "4.14.0" }, { - "description": "Creates a Storage network IP range.", - "isasync": true, - "name": "createStorageNetworkIpRange", + "description": "Lists System VM stats", + "isasync": false, + "name": "listSystemVmsUsageHistory", "params": [ { - "description": "the gateway for storage network", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "UUID of pod where the ip range belongs to", + "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "ids", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": false, + "type": "list" }, { - "description": "the beginning IP address", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "startip", - "required": true, - "type": "string" + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the netmask for storage network", + "description": "List by keyword", "length": 255, - "name": "netmask", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ending IP address", + "description": "", "length": 255, - "name": "endip", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "description": "the ID of the system VM.", "length": 255, - "name": "vlan", + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, "type": "integer" } @@ -112217,50 +120446,59 @@ "related": "", "response": [ { - "description": "the netmask of the storage network IP range", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" - }, - { - "description": "the uuid of storage network IP range.", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" - }, + } + ], + "since": "4.18.0" + }, + { + "description": "Deletes a IPv6 firewall rule", + "isasync": true, + "name": "deleteIpv6FirewallRule", + "params": [ { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" + "description": "the ID of the IPv6 firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -112268,603 +120506,759 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists all children domains belonging to a specified domain", - "isasync": false, - "name": "listDomainChildren", + "description": "Creates a physical network", + "isasync": true, + "name": "createPhysicalNetwork", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "the name of the physical network", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "page", + "name": "networkspeed", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list children domains by name", + "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": "name", + "name": "broadcastdomainrange", "required": false, "type": "string" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, - "name": "isrecursive", + "name": "isolationmethods", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "", + "description": "domain ID of the account owning a physical network", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list children domain by parent domain ID.", + "description": "Tag the physical network", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", + "name": "tags", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "List by keyword", + "description": "the VLAN for the physical network", "length": 255, - "name": "keyword", + "name": "vlan", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for domains", + "description": "the Zone ID for the physical network", "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], - "related": "listDomains", + "related": "", "response": [ { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the vlan of the physical network", + "name": "vlan", + "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the uuid of the physical network", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "comma separated tag", + "name": "tags", + "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "name of the physical network", + "name": "name", + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists autoscale vm groups.", + "isasync": false, + "name": "listAutoScaleVmGroups", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the ID of the policy", + "length": 255, + "name": "policyid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject", + "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 autoscale vm group", + "length": 255, + "name": "id", + "related": "listAutoScaleVmGroups", + "required": false, + "type": "uuid" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the name of the autoscale vmgroup", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the ID of the loadbalancer", + "length": 255, + "name": "lbruleid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the ID of the profile", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile", + "required": false, + "type": "uuid" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "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 public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "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 total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, - {}, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "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 snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "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 ID of the domain", - "name": "id", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the private port", + "name": "privateport", "type": "string" }, + {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the date when this domain was created", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the date when this vm group was created", "name": "created", "type": "date" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the public ip address id", + "name": "publicipid", "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": "Returns an encrypted password for the VM", - "isasync": false, - "name": "getVMPassword", + "description": "Creates a firewall rule for a given IP address", + "isasync": true, + "name": "createFirewallRule", "params": [ { - "description": "The ID of the virtual machine", + "description": "type of firewallrule: system/user", "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "name": "type", + "required": false, + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, - {}, - {}, { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "length": 255, + "name": "protocol", + "required": true, "type": "string" - } - ] - }, - { - "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", - "isasync": true, - "name": "assignToGlobalLoadBalancerRule", - "params": [ + }, { - "description": "the ID of the global load balancer rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "error code for this icmp message", "length": 255, - "name": "loadbalancerrulelist", - "related": "", - "required": true, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, "type": "list" }, { - "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "the starting port of firewall rule", "length": 255, - "name": "gslblbruleweightsmap", + "name": "startport", "required": false, - "type": "map" + "type": "integer" } ], + "related": "updateEgressFirewallRule", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Configures an ovs element.", - "isasync": true, - "name": "configureOvsElement", - "params": [ - { - "description": "the ID of the ovs provider", - "length": 255, - "name": "id", - "related": "configureOvsElement", - "required": true, - "type": "uuid" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - } - ], - "related": "", - "response": [ + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, { - "description": "the id of the ovs", - "name": "id", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "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", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "Adds S3 Image Store", - "isasync": false, - "name": "addImageStoreS3", + "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", + "isasync": true, + "name": "createVolume", "params": [ { - "description": "Connection timeout (milliseconds)", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "connectiontimeout", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Socket timeout (milliseconds)", + "description": "the name of the disk volume", "length": 255, - "name": "sockettimeout", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Whether TCP keep-alive is used", + "description": "max iops", "length": 255, - "name": "usetcpkeepalive", + "name": "maxiops", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "Arbitrary volume size", "length": 255, - "name": "s3signer", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "Maximum number of times to retry on error", + "description": "an optional field, whether to display the volume to the end user or not.", "length": 255, - "name": "maxerrorretry", + "name": "displayvolume", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Connection TTL (milliseconds)", + "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": "connectionttl", + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "S3 access key", + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", "length": 255, - "name": "accesskey", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "Name of the storage bucket", + "description": "min iops", "length": 255, - "name": "bucket", - "required": true, - "type": "string" + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "Use HTTPS instead of HTTP", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "usehttps", + "name": "diskofferingid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "S3 secret key", + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "secretkey", - "required": true, - "type": "string" + "name": "snapshotid", + "related": "listSnapshots", + "required": false, + "type": "uuid" }, { - "description": "S3 endpoint", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "endpoint", - "required": true, + "name": "customid", + "required": false, "type": "string" + }, + { + "description": "the project associated with the volume. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], - "related": "listImageStores", + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -112872,349 +121266,318 @@ "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 project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, - {} - ], - "since": "4.7.0" - }, - { - "description": "Upload a certificate for HTTPS direct template download on KVM hosts", - "isasync": false, - "name": "uploadTemplateDirectDownloadCertificate", - "params": [ { - "description": "Hypervisor type", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", - "required": true, + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "Zone to upload certificate", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "SSL certificate", - "length": 65535, - "name": "certificate", - "required": true, - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project 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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "(optional) the host ID to upload certificate", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the direct download certificate serial num", - "name": "serialnum", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, + {}, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "shared or local storage", + "name": "storagetype", "type": "string" - } - ], - "since": "4.11.0" - }, - { - "description": "Import unmanaged virtual machine from a given cluster.", - "isasync": true, - "name": "importUnmanagedInstance", - "params": [ - { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" }, + {}, { - "description": "import instance for the project", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "VM nic to network id mapping using keys nic and network", - "length": 255, - "name": "nicnetworklist", - "required": false, - "type": "map" + "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", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "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 write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", - "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the host name of the instance", - "length": 255, - "name": "hostname", - "required": false, + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the hypervisor name of the instance", - "length": 255, - "name": "name", - "required": true, + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "import instance to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "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 group ID of the virtual machine", - "name": "groupid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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 virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the 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", + "type": "string" }, - {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { "description": "the VM's disk read in KiB", @@ -113222,378 +121585,252 @@ "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "max iops of the disk volume", + "name": "maxiops", "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", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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 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": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project name of the vpn", + "name": "project", "type": "string" + } + ] + }, + { + "description": "List virtual machine snapshot by conditions", + "isasync": false, + "name": "listVMSnapshot", + "params": [ + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "type": "uuid" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "length": 255, + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "since": "4.9", + "type": "list" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "state of the virtual machine snapshot", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the 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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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" - } - ], - "type": "set" + "description": "lists snapshot by snapshot name or display name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + } + ], + "related": "createVMSnapshot", + "response": [ + { + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "the project name of the vm", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the parent ID of the vm snapshot", + "name": "parent", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -113601,28 +121838,28 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -113631,1016 +121868,745 @@ "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + } + ], + "since": "4.2.0" + }, + { + "description": "Updates a Pod.", + "isasync": false, + "name": "updatePod", + "params": [ + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ending IP address for the Pod", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the Pod", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the netmask of the Pod", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the starting IP address for the Pod", + "length": 255, + "name": "startip", + "required": false, + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the ID of the Pod", + "length": 255, + "name": "id", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "related": "createManagementNetworkIpRange", + "response": [ + {}, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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 value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" } ], - "type": "set" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the Pod", + "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 Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the netmask of the Pod", + "name": "netmask", "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": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" } - ], - "since": "4.14.0" + ] }, { - "description": "Lists System VM stats", - "isasync": false, - "name": "listSystemVmsUsageHistory", + "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", + "isasync": true, + "name": "moveNetworkAclItem", "params": [ { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "the ID of the system VM.", + "description": "The ID of the network ACL rule that is being moved to a new position.", "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", "length": 255, - "name": "keyword", + "name": "nextaclruleid", "required": false, "type": "string" }, { - "description": "the IDs of the system VMs, mutually exclusive with id.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "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", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "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": "startdate", + "name": "aclconsistencyhash", "required": false, - "type": "date" + "type": "string" }, { - "description": "", + "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": "page", + "name": "previousaclruleid", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the 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 list of VM stats", - "name": "stats", - "type": "list" - } - ], - "since": "4.18.0" - }, - { - "description": "Deletes a IPv6 firewall rule", - "isasync": true, - "name": "deleteIpv6FirewallRule", - "params": [ + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { - "description": "the ID of the IPv6 firewall rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, {}, { "description": "the 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", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" - } - ] - }, - { - "description": "Creates a physical network", - "isasync": true, - "name": "createPhysicalNetwork", - "params": [ + }, { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", - "length": 255, - "name": "broadcastdomainrange", - "required": false, + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", - "length": 255, - "name": "isolationmethods", - "required": false, + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], "type": "list" }, + {}, { - "description": "the VLAN for the physical network", - "length": 255, - "name": "vlan", - "required": false, + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the name of the physical network", - "length": 255, - "name": "name", - "required": true, + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + } + ] + }, + { + "description": "Attaches an ISO to a virtual machine.", + "isasync": true, + "name": "attachIso", + "params": [ + { + "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, - "name": "networkspeed", + "name": "forced", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { - "description": "domain ID of the account owning a physical network", + "description": "the ID of the ISO file", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, "type": "uuid" }, { - "description": "Tag the physical network", + "description": "the ID of the virtual machine", "length": 255, - "name": "tags", - "required": false, - "type": "list" + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "response": [ { - "description": "the 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", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, - {}, { - "description": "comma separated tag", - "name": "tags", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "name of the physical network", - "name": "name", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "state of the physical network", - "name": "state", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "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": "zone name of the physical network", - "name": "zonename", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists autoscale vm groups.", - "isasync": false, - "name": "listAutoScaleVmGroups", - "params": [ + }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the autoscale vm group", - "length": 255, - "name": "id", - "related": "listAutoScaleVmGroups", - "required": false, - "type": "uuid" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the loadbalancer", - "length": 255, - "name": "lbruleid", - "related": "", - "required": false, - "type": "uuid" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the ID of the profile", - "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", - "required": false, - "type": "uuid" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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 project name of the vm", + "name": "project", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the policy", - "length": 255, - "name": "policyid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, {}, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "the public ip address", - "name": "publicip", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -114649,217 +122615,745 @@ "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the date when this vm group 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - } - ] - }, - { - "description": "Creates a firewall rule for a given IP address", - "isasync": true, - "name": "createFirewallRule", - "params": [ + }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "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": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - } - ], - "related": "updateEgressFirewallRule", - "response": [ + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the state of the rule", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "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 value", + "name": "value", "type": "string" }, { @@ -114872,832 +123366,918 @@ "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", + "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": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, - {}, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" } ] }, { - "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", + "description": "Disassociates an IP address from the account.", "isasync": true, - "name": "createVolume", + "name": "disassociateIpAddress", "params": [ { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", - "length": 255, - "name": "snapshotid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the availability zone", + "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "ipaddress", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", "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": "id", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" - }, + } + ], + "response": [ + {}, { - "description": "max iops", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "min iops", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Arbitrary volume size", - "length": 255, - "name": "size", - "required": false, - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ] + }, + { + "description": "list baremetal dhcp servers", + "isasync": false, + "name": "listBaremetalDhcp", + "params": [ { - "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": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "the Physical Network ID", "length": 255, - "name": "diskofferingid", + "name": "physicalnetworkid", "related": "", - "required": false, + "required": true, "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "Type of DHCP device", "length": 255, - "name": "name", + "name": "dhcpservertype", "required": false, "type": "string" }, { - "description": "an optional field, whether to display the volume to the end user or not.", + "description": "", "length": 255, - "name": "displayvolume", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "DHCP server device ID", "length": 255, - "name": "customid", + "name": "id", "required": false, - "type": "string" + "type": "long" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "", "response": [ { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "url", + "name": "url", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "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", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the provider", + "name": "provider", "type": "string" - }, + } + ] + }, + { + "description": "Puts storage pool into maintenance state", + "isasync": true, + "name": "enableStorageMaintenance", + "params": [ { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "Primary storage ID", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,enableStorageMaintenance", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance", + "response": [ + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "name of the availability zone", + "description": "the Zone name of the storage pool", "name": "zonename", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the path of the volume", + "description": "the storage pool path", "name": "path", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, - {}, - { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Removes an existing secondary storage selector.", + "isasync": false, + "name": "removeSecondaryStorageSelector", + "params": [ { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, + "description": "The unique identifier of the secondary storage selector to be removed.", + "length": 255, + "name": "id", + "related": "removeSecondaryStorageSelector", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", + "isasync": false, + "name": "ldapRemove", + "params": [], + "related": "", + "response": [ { - "description": "the project name of the vpn", - "name": "project", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the current status of the latest 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": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, + {}, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "DN password", + "name": "bindpass", "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "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" } - ] + ], + "since": "3.0.1" }, { - "description": "List virtual machine snapshot by conditions", + "description": "Creates a user for an account that already exists", "isasync": false, - "name": "listVMSnapshot", + "name": "createUser", "params": [ { - "description": "", + "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": "pagesize", - "required": false, - "type": "integer" + "name": "account", + "required": true, + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "isrecursive", + "name": "timezone", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "lastname", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "since": "4.9", - "type": "list" + "name": "lastname", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "firstname", "length": 255, - "name": "keyword", - "required": false, + "name": "firstname", + "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": "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": "listall", - "required": false, - "type": "boolean" + "name": "password", + "required": true, + "type": "string" }, { - "description": "the ID of the vm", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "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": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "email", "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "name": "email", + "required": true, + "type": "string" }, { - "description": "The ID of the VM snapshot", + "description": "Unique username.", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "tags", + "name": "userid", "required": false, - "type": "map" + "type": "string" + } + ], + "related": "getUser", + "response": [ + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "state of the virtual machine snapshot", - "length": 255, - "name": "state", - "required": false, + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "lists snapshot by snapshot name or display name", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the domain ID of the user", "name": "domainid", - "related": "listDomains", - "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 user lastname", + "name": "lastname", "type": "string" - } - ], - "related": "createVMSnapshot", - "response": [ - {}, + }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "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 create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "indicates if this is current snapshot", - "name": "current", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "the user state", + "name": "state", "type": "string" }, + {}, { - "description": "VM Snapshot type", - "name": "type", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 user ID", + "name": "id", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, + {}, { - "description": "the name of the vm snapshot", + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + } + ] + }, + { + "description": "lists all available apis on the server, provided by the Api Discovery plugin", + "isasync": false, + "name": "listApis", + "params": [ + { + "description": "API name", + "length": 255, "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the project name of the vpn", - "name": "project", + "description": "the name of the api command", + "name": "name", "type": "string" }, { - "description": "the description of the vm snapshot", - "name": "description", + "description": "comma separated related apis", + "name": "related", "type": "string" }, { - "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 parent ID of the vm snapshot", - "name": "parent", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "description of the api", + "name": "description", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" + }, + { + "description": "the list params the api accepts", + "name": "params", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "comma separated related apis to get the parameter", + "name": "related", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "description of the api parameter", + "name": "description", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "length of the parameter", + "name": "length", + "type": "int" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "parameter type", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the api parameter", + "name": "name", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "response field type", + "name": "type", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "response field type", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "description of the api response field", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "api response fields", + "name": "response", + "type": "set" + }, + { + "description": "the name of the api response field", + "name": "name", "type": "string" } ], "type": "set" + } + ], + "since": "4.1.0" + }, + { + "description": "deletes baremetal rack configuration text", + "isasync": true, + "name": "deleteBaremetalRct", + "params": [ + { + "description": "RCT id", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", + "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": "Creates site to site vpn local gateway", + "isasync": true, + "name": "createVpnGateway", + "params": [ + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "public ip address id of the vpn gateway", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the domain id of the owner", "name": "domainid", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + }, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, { @@ -115706,311 +124286,191 @@ "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, {} - ], - "since": "4.2.0" + ] }, { - "description": "Updates a Pod.", - "isasync": false, - "name": "updatePod", + "description": "Creates snapshot for a vm.", + "isasync": true, + "name": "createVMSnapshot", "params": [ { - "description": "the gateway for the Pod", - "length": 255, - "name": "gateway", - "required": false, - "type": "string" - }, - { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "The description of the snapshot", "length": 255, - "name": "allocationstate", + "name": "description", "required": false, "type": "string" }, { - "description": "the netmask of the Pod", + "description": "The display name of the snapshot", "length": 255, - "name": "netmask", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the Pod", - "length": 255, - "name": "id", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the Pod", + "description": "snapshot memory if true", "length": 255, - "name": "name", + "name": "snapshotmemory", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ending IP address for the Pod", + "description": "quiesce vm if true", "length": 255, - "name": "endip", + "name": "quiescevm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the starting IP address for the Pod", + "description": "The ID of the vm", "length": 255, - "name": "startip", - "required": false, - "type": "string" + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": true, + "type": "uuid" } ], - "related": "createManagementNetworkIpRange", + "related": "", "response": [ - {}, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "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 gateway for the range", - "name": "gateway", - "type": "string" - } - ], - "type": "list" - }, { - "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "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 vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - } - ], - "type": "list" + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, - {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" - } - ] - }, - { - "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", - "isasync": true, - "name": "moveNetworkAclItem", - "params": [ + }, { - "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", - "length": 255, - "name": "nextaclruleid", - "required": false, + "description": "the name of the vm snapshot", + "name": "name", "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, + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", - "length": 255, - "name": "aclconsistencyhash", - "required": false, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "The ID of the network ACL rule that is being moved to a new position.", - "length": 255, + "description": "the ID of the vm snapshot", "name": "id", - "required": true, "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -116019,51 +124479,46 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "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": "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": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "type": "set" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { @@ -116072,1279 +124527,1351 @@ "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Adds detail for the Resource.", + "isasync": true, + "name": "addResourceDetail", + "params": [ { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": true, + "type": "map" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "pass false if you want this detail to be disabled for the regular user. True by default", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "resource id to create the details for", + "length": 255, + "name": "resourceid", + "required": true, "type": "string" - }, + } + ], + "response": [ { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "Lists vpn users", + "isasync": false, + "name": "listVpnUsers", + "params": [ { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "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 traffic type for the ACL", - "name": "traffictype", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - } - ] - }, - { - "description": "Attaches an ISO to a virtual machine.", - "isasync": true, - "name": "attachIso", - "params": [ + }, { - "description": "the ID of the ISO file", + "description": "The uuid of the Vpn user", "length": 255, "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, + "related": "addVpnUser,listVpnUsers", + "required": false, "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "If true, ejects existing ISO before attaching on VMware. Default: false", + "description": "the username of the vpn user.", "length": 255, - "name": "forced", + "name": "username", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" } ], - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "related": "addVpnUser", "response": [ { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", + "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the vpn userID", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, + {} + ] + }, + { + "description": "Deletes an internal load balancer", + "isasync": true, + "name": "deleteLoadBalancer", + "params": [ { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, + "description": "the ID of the Load Balancer", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes an IP forwarding rule", + "isasync": true, + "name": "deleteIpForwardingRule", + "params": [ { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the forwarding rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "any text associated with the success or failure", + "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": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the 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" - } - ], - "type": "set" + "description": "Userdata content", + "length": 1048576, + "name": "userdata", + "required": true, + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "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": "OS type id of the vm", - "name": "ostypeid", + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" + }, + { + "description": "comma separated list of variables declared in userdata content", + "length": 255, + "name": "params", + "required": false, "type": "string" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.18" + }, + { + "description": "Adds a Region", + "isasync": false, + "name": "addRegion", + "params": [ + { + "description": "Name of the region", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Region service endpoint", + "length": 255, + "name": "endpoint", + "required": true, + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Id of the Region", + "length": 255, + "name": "id", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "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" + }, + {}, + { + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the region", + "name": "name", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the region", + "name": "id", + "type": "integer" }, + {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", "type": "boolean" + } + ] + }, + { + "description": "Lists Tungsten-Fabric tags", + "isasync": false, + "name": "listTungstenFabricTagType", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": false, "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the 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 group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Tungsten-Fabric tag type name", + "name": "name", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" + } + ] + }, + { + "description": "Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed", + "isasync": false, + "name": "generateUsageRecords", + "params": [ + { + "description": "List events for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", + "length": 255, + "name": "startdate", + "required": true, + "type": "date" + } + ], + "response": [ + { + "description": "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 vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Updates a role permission order", + "isasync": false, + "name": "updateRolePermission", + "params": [ + { + "description": "Role permission rule id", + "length": 255, + "name": "ruleid", + "related": "", + "required": false, + "since": "4.11", + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", + "related": "", + "required": false, + "type": "list" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Rule permission, can be: allow or deny", + "length": 255, + "name": "permission", + "required": false, + "since": "4.11", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "4.9.0" + }, + { + "description": "List registered keypairs", + "isasync": false, + "name": "listSSHKeyPairs", + "params": [ { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "A key pair name to look for", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "A public key fingerprint to look for", + "length": 255, + "name": "fingerprint", + "required": false, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" }, { - "description": "the name of the virtual machine", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the ssh keypair", + "length": 255, + "name": "id", + "related": "listSSHKeyPairs", + "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 by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Name of the keypair", "name": "name", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the domain name of the keypair owner", + "name": "domain", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the UUID of the latest async job acting on 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 accounts and provides detailed account information for listed accounts", + "isasync": false, + "name": "listAccounts", + "params": [ + { + "description": "list accounts by cleanuprequired attribute (values are true or false)", + "length": 255, + "name": "iscleanuprequired", + "required": false, + "type": "boolean" + }, + { + "description": "flag to display the resource icon for accounts", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, + "type": "list" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list account by account ID", + "length": 255, + "name": "id", + "related": "enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "list account by account name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "enableAccount,listAccounts", + "response": [ + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the list of users associated with account", + "name": "user", "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ], - "type": "set" + "type": "list" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "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 templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the 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 available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" - } - ] - }, - { - "description": "Disassociates an IP address from the account.", - "isasync": true, - "name": "disassociateIpAddress", - "params": [ + }, { - "description": "the ID of the public IP address to disassociate", - "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "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", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "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 snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "list baremetal dhcp servers", - "isasync": false, - "name": "listBaremetalDhcp", - "params": [ + "description": "the name of the account", + "name": "name", + "type": "string" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "DHCP server device ID", - "length": 255, + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the id of the account", "name": "id", - "required": false, + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "Type of DHCP device", - "length": 255, - "name": "dhcpservertype", - "required": false, + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + {}, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, { - "description": "name of the provider", - "name": "dhcpservertype", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "name of the provider", - "name": "provider", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "device id of ", - "name": "id", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "url", - "name": "url", + "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 physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" } ] }, { - "description": "Puts storage pool into maintenance state", + "description": "Cancels maintenance for primary storage", "isasync": true, - "name": "enableStorageMaintenance", + "name": "cancelStorageMaintenance", "params": [ { - "description": "Primary storage ID", + "description": "the primary storage ID", "length": 255, "name": "id", - "related": "cancelStorageMaintenance,enableStorageMaintenance", + "related": "cancelStorageMaintenance", "required": true, "type": "uuid" } ], - "related": "cancelStorageMaintenance", + "related": "", "response": [ { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -117352,54 +125879,55 @@ "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "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": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, { "description": "the host's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the storage pool path", - "name": "path", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { "description": "the storage pool capabilities", @@ -117407,60 +125935,55 @@ "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod name of the storage pool", + "name": "podname", "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -117470,20 +125993,206 @@ ] }, { - "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", - "isasync": false, - "name": "ldapRemove", - "params": [], + "description": "Destroys a router.", + "isasync": true, + "name": "destroyRouter", + "params": [ + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter", + "required": true, + "type": "uuid" + } + ], "related": "", "response": [ { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the domain ID associated with the router", + "name": "domainid", "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": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 netmask of the nic", + "name": "netmask", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the 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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { @@ -117491,621 +126200,584 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "the id of the router", + "name": "id", "type": "string" }, - {}, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "the Pod name for the router", + "name": "podname", "type": "string" - } - ], - "since": "3.0.1" - }, - { - "description": "Creates a user for an account that already exists", - "isasync": false, - "name": "createUser", - "params": [ + }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": true, + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" - } - ], - "related": "getUser", - "response": [ + }, { - "description": "the account name of the user", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the account associated with the router", + "name": "account", "type": "string" }, + {}, { - "description": "the user ID", - "name": "id", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the project name of the address", + "name": "project", + "type": "string" }, - {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the date and time the user account was created", + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date and time the router was created", "name": "created", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" } ] }, { - "description": "lists all available apis on the server, provided by the Api Discovery plugin", - "isasync": false, - "name": "listApis", + "description": "Updates the snapshot policy.", + "isasync": true, + "name": "updateSnapshotPolicy", "params": [ { - "description": "API name", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, + "since": "4.4", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "comma separated related apis", - "name": "related", - "type": "string" + "description": "the ID of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy", + "required": false, + "type": "uuid" }, { - "description": "true if api is asynchronous", - "name": "isasync", + "description": "an optional field, whether to the display the snapshot policy to the end user or not.", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" - }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "api response fields", - "name": "response", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "response field type", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the name of the api response field", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "api response fields", - "name": "response", - "type": "set" - }, - { - "description": "description of the api response field", - "name": "description", + "description": "resource type", + "name": "resourcetype", "type": "string" - } - ], - "type": "set" - }, - { - "description": "response field type", - "name": "type", - "type": "string" - }, - {}, - { - "description": "the name of the api command", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the list params the api accepts", - "name": "params", - "response": [ + }, { - "description": "description of the api parameter", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "comma separated related apis to get the parameter", - "name": "related", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "parameter type", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "length of the parameter", - "name": "length", - "type": "int" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the name of the api parameter", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, + {}, { - "description": "description of the api", - "name": "description", + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" - } - ], - "since": "4.1.0" - }, - { - "description": "deletes baremetal rack configuration text", - "isasync": true, - "name": "deleteBaremetalRct", - "params": [ + }, { - "description": "RCT id", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the 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 list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "is this policy for display to the regular user", + "name": "fordisplay", "type": "boolean" }, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, {}, - {} + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Creates site to site vpn local gateway", - "isasync": true, - "name": "createVpnGateway", + "description": "Retrieves the current status of asynchronous job.", + "isasync": false, + "name": "queryAsyncJobResult", "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", + "description": "the ID of the asynchronous job", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "jobid", + "related": "queryAsyncJobResult", "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" }, { - "description": "the project id", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", - "type": "string" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, - {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the project name", - "name": "project", - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - } - ] - }, - { - "description": "Creates snapshot for a vm.", - "isasync": true, - "name": "createVMSnapshot", - "params": [ - { - "description": "The ID of the vm", - "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" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "The display name of the snapshot", - "length": 255, - "name": "name", - "required": false, + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "The description of the snapshot", - "length": 255, - "name": "description", - "required": false, + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "quiesce vm if true", - "length": 255, - "name": "quiescevm", - "required": false, - "type": "boolean" - }, - { - "description": "snapshot memory if true", - "length": 255, - "name": "snapshotmemory", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, - {}, { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the account id that executed the async command", + "name": "accountid", "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": "Adds a netscaler control center device", + "isasync": true, + "name": "registerNetscalerControlCenter", + "params": [ { - "description": "VM Snapshot type", - "name": "type", + "description": "Credentials to reach netscaler controlcenter device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "Credentials to reach netscaler controlcenter device", + "length": 255, + "name": "numretries", + "required": true, + "type": "integer" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Credentials to reach netscaler controlcenter device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "URL of the netscaler controlcenter appliance.", + "length": 255, + "name": "ipaddress", + "required": true, "type": "string" - }, + } + ], + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "response": [ { - "description": "the account associated with the disk volume", - "name": "account", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "device name", + "name": "lbdevicename", "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" }, { @@ -118114,177 +126786,87 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", - "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 display name of the vm snapshot", - "name": "displayname", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "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", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Adds detail for the Resource.", - "isasync": true, - "name": "addResourceDetail", - "params": [ - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": true, - "type": "map" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "resource id to create the details for", - "length": 255, - "name": "resourceid", - "required": true, + "description": "device state", + "name": "lbdevicestate", "type": "string" }, - { - "description": "pass false if you want this detail to be disabled for the regular user. True by default", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "response": [ - { - "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": "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 private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + {} ] }, { - "description": "Lists vpn users", + "description": "Lists image stores.", "isasync": false, - "name": "listVpnUsers", + "name": "listImageStores", "params": [ { - "description": "List by keyword", + "description": "read-only status of the image store", "length": 255, - "name": "keyword", + "name": "readonly", + "related": "listImageStores", "required": false, - "type": "string" + "since": "4.15.0", + "type": "boolean" }, { "description": "", @@ -118294,136 +126876,150 @@ "type": "integer" }, { - "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", + "description": "the image store provider", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the username of the vpn user.", + "description": "the name of the image store", "length": 255, - "name": "username", + "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": "the ID of the storage pool", "length": 255, - "name": "listall", + "name": "id", + "related": "listImageStores", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the Zone ID for the image store", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The uuid of the Vpn user", + "description": "the image store protocol", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "addVpnUser", + "related": "", "response": [ { - "description": "the username of the vpn user", - "name": "username", + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the vpn userID", - "name": "id", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the url of the image store", + "name": "url", "type": "string" }, {}, { - "description": "the state of the Vpn User", - "name": "state", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, - {} - ] + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + } + ], + "since": "4.2.0" }, { - "description": "Deletes an internal load balancer", + "description": "Deletes a account, and all users associated with this account", "isasync": true, - "name": "deleteLoadBalancer", + "name": "deleteAccount", "params": [ { - "description": "the ID of the Load Balancer", + "description": "Account id", "length": 255, "name": "id", - "related": "", + "related": "enableAccount,listAccounts", "required": true, "type": "uuid" } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -118444,259 +127040,177 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} - ], - "since": "4.2.0" + } + ] }, { - "description": "Deletes an IP forwarding rule", + "description": "Adds metric counter for VM auto scaling", "isasync": true, - "name": "deleteIpForwardingRule", + "name": "createCounter", "params": [ { - "description": "the ID of the forwarding rule", + "description": "Network provider of the counter.", "length": 255, - "name": "id", - "related": "", + "name": "provider", "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "since": "4.18.0", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Register a new userdata.", - "isasync": false, - "name": "registerUserData", - "params": [ - { - "description": "Name of the userdata", + "description": "Name of the counter.", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "comma separated list of variables declared in userdata content", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "params", - "required": false, - "type": "string" - }, - { - "description": "Userdata content", - "length": 1048576, - "name": "userdata", + "name": "value", "required": true, "type": "string" }, { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "Source of the counter.", "length": 255, - "name": "account", - "required": false, + "name": "source", + "required": true, "type": "string" - }, - { - "description": "an optional project for the userdata", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" } ], + "related": "", "response": [ + { + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" - } - ], - "since": "4.18" - }, - { - "description": "Adds a Region", - "isasync": false, - "name": "addRegion", - "params": [ + }, { - "description": "Name of the region", - "length": 255, - "name": "name", - "required": true, + "description": "Source of the counter.", + "name": "source", "type": "string" }, { - "description": "Id of the Region", - "length": 255, - "name": "id", - "required": true, - "type": "integer" + "description": "Provider of the counter.", + "name": "provider", + "type": "string" }, { - "description": "Region service endpoint", - "length": 255, - "name": "endpoint", - "required": true, + "description": "Name of the counter.", + "name": "name", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the region", - "name": "id", - "type": "integer" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "the id of the Counter", + "name": "id", + "type": "string" }, + {} + ] + }, + { + "description": "List Event Types", + "isasync": false, + "name": "listEventTypes", + "params": [], + "related": "", + "response": [ {}, {}, { - "description": "the end point of the region", - "name": "endpoint", + "description": "Event Type", + "name": "name", "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the name of the region", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, { - "description": "Lists Tungsten-Fabric tags", - "isasync": false, - "name": "listTungstenFabricTagType", + "description": "Disables out-of-band management for a cluster", + "isasync": true, + "name": "disableOutOfBandManagementForCluster", "params": [ { - "description": "List by keyword", + "description": "the ID of the cluster", "length": 255, - "name": "keyword", - "required": false, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "tagtypeuuid", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the out-of-band management driver for the host", + "name": "driver", "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": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "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 current status of the latest async job acting on this object", @@ -118704,231 +127218,344 @@ "type": "integer" }, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + {} + ], + "since": "4.9.0" }, { - "description": "Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed", + "description": "Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted", "isasync": false, - "name": "generateUsageRecords", + "name": "prepareForShutdown", "params": [ { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" - }, - { - "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", + "description": "the uuid of the management server", "length": 255, - "name": "startdate", + "name": "managementserverid", + "related": "", "required": true, - "type": "date" - }, - { - "description": "List events for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, "type": "uuid" } ], + "related": "", "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", "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", - "type": "string" + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" } - ] + ], + "since": "4.19.0" }, { - "description": "Updates a role permission order", + "description": "Adds a new cluster", "isasync": false, - "name": "updateRolePermission", + "name": "addCluster", "params": [ { - "description": "Rule permission, can be: allow or deny", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "permission", + "name": "ovm3cluster", "required": false, - "since": "4.11", "type": "string" }, { - "description": "ID of the role", + "description": "the Pod ID for the host", "length": 255, - "name": "roleid", - "related": "", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, "type": "uuid" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "ruleorder", - "related": "", - "required": false, - "type": "list" + "name": "clustertype", + "required": true, + "type": "string" }, { - "description": "Role permission rule id", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "ruleid", - "related": "", + "name": "ovm3pool", "required": false, - "since": "4.11", - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": true, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Ovm3 vip to use for pool (and cluster)", + "length": 255, + "name": "ovm3vip", + "required": false, + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "List registered keypairs", - "isasync": false, - "name": "listSSHKeyPairs", - "params": [ + }, { - "description": "A public key fingerprint to look for", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "fingerprint", + "name": "vsmpassword", "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": "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": "listall", + "name": "guestvswitchtype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "the URL", "length": 255, - "name": "keyword", + "name": "url", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "publicvswitchtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the username for the cluster", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "page", + "name": "vsmipaddress", "required": false, - "type": "integer" + "type": "string" }, { - "description": "A key pair name to look for", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "name", + "name": "allocationstate", "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 username for the VSM associated with this cluster", "length": 255, - "name": "isrecursive", + "name": "vsmusername", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the Zone ID for the cluster", "length": 255, - "name": "account", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "length": 255, + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "the ID of the ssh keypair", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "publicvswitchname", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "Name of the keypair", + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + } + ], + "type": "list" + }, + {}, + { + "description": "the cluster name", "name": "name", "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, {}, @@ -118937,746 +127564,1134 @@ "name": "jobid", "type": "string" }, - {}, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + } + ] + }, + { + "description": "Deletes an traffic monitor host.", + "isasync": false, + "name": "deleteTrafficMonitor", + "params": [ + { + "description": "Id of the Traffic Monitor Host.", + "length": 255, + "name": "id", + "related": "reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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": "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": "Removes VM from specified network by deleting a NIC", + "isasync": true, + "name": "removeNicFromVirtualMachine", + "params": [ + { + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": true, + "type": "uuid" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "NIC ID", + "length": 255, + "name": "nicid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "response": [ + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the project name of the keypair owner", + "description": "the project name of the vm", "name": "project", "type": "string" - } - ] - }, - { - "description": "Lists accounts and provides detailed account information for listed accounts", - "isasync": false, - "name": "listAccounts", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", - "length": 255, - "name": "iscleanuprequired", - "required": false, - "type": "boolean" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", - "length": 255, - "name": "state", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", - "length": 255, - "name": "accounttype", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "list account by account ID", - "length": 255, - "name": "id", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "list account by account name", - "length": 255, - "name": "name", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, + {}, { - "description": "flag to display the resource icon for accounts", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - } - ], - "related": "enableAccount,listAccounts", - "response": [ + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, - {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "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": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "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": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "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", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the user ID", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], - "type": "list" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "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" + "type": "set" }, - {}, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ] - }, - { - "description": "Cancels maintenance for primary storage", - "isasync": true, - "name": "cancelStorageMaintenance", - "params": [ - { - "description": "the primary storage ID", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the date and time the storage pool 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 storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the Zone name of the storage pool", + "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, - { - "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 Pod name of the storage pool", - "name": "podname", - "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 state of the virtual machine", + "name": "state", + "type": "string" + } ] }, { - "description": "Destroys a router.", + "description": "Activates a project", "isasync": true, - "name": "destroyRouter", + "name": "activateProject", "params": [ { - "description": "the ID of the router", + "description": "id of the project to be modified", "length": 255, "name": "id", - "related": "destroyRouter", + "related": "activateProject", "required": true, "type": "uuid" } @@ -119684,592 +128699,332 @@ "related": "", "response": [ { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "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 total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, - {}, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated with vm", + "name": "tags", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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 type of the nic", - "name": "type", - "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": "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, - {}, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, + {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the date and time the router was created", + "description": "the date this project was created", "name": "created", "type": "date" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, + {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" - } - ] - }, - { - "description": "Updates the snapshot policy.", - "isasync": true, - "name": "updateSnapshotPolicy", - "params": [ - { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" }, { - "description": "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 volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the ID of the snapshot policy", - "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the domain name where the project belongs to", + "name": "domain", "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 total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "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": "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 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" - } - ], - "type": "set" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Delete a certificate to CloudStack", + "isasync": false, + "name": "deleteSslCert", + "params": [ { - "description": "the ID of the snapshot policy", + "description": "Id of SSL certificate", + "length": 255, "name": "id", + "related": "uploadSslCert", + "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 the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { @@ -120280,45 +129035,46 @@ ] }, { - "description": "Lists balance and quota usage for all accounts", + "description": "Lists dedicated hosts.", "isasync": false, - "name": "quotaSummary", + "name": "listDedicatedHosts", "params": [ { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Optional, Account Id for which statement needs to be generated", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of the host", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Optional, to list all accounts irrespective of the quota activity", + "description": "the name of the account associated with the host. Must be used with domainId.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -120326,229 +129082,343 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "list dedicated hosts by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "start date", - "name": "startdate", - "type": "date" - }, - { - "description": "end date", - "name": "enddate", - "type": "date" - }, - {}, - { - "description": "account state", - "name": "state", - "type": "state" - }, - { - "description": "currency", - "name": "currency", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, + {}, { - "description": "account id", + "description": "the Account ID of the host", "name": "accountid", "type": "string" }, { - "description": "account name", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if the account has the quota config enabled", - "name": "quotaenabled", - "type": "boolean" - }, - { - "description": "quota usage of this period", - "name": "quota", - "type": "bigdecimal" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "domain name", - "name": "domain", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, - {}, { - "description": "domain id", - "name": "domainid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, - { - "description": "account balance", - "name": "balance", - "type": "bigdecimal" - } - ], - "since": "4.7.0" + {} + ] }, { - "description": "Retrieves the current status of asynchronous job.", + "description": "upload an existing ISO into the CloudStack cloud.", "isasync": false, - "name": "queryAsyncJobResult", + "name": "getUploadParamsForIso", "params": [ { - "description": "the ID of the asynchronous job", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "jobid", - "related": "queryAsyncJobResult", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" }, { - "description": "the account id that executed the async command", - "name": "accountid", + "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": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "the account that executed the async command", + "description": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "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": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "the async command executed", - "name": "cmd", + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" + }, + {}, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" + } + ], + "since": "4.13" + }, + { + "description": "Get diagnostics and files from system VMs", + "isasync": true, + "name": "getDiagnosticsData", + "params": [ + { + "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "length": 255, + "name": "targetid", + "related": "", + "required": true, + "type": "uuid" }, + { + "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", + "length": 255, + "name": "files", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current job status-should be 0 for PENDING", + "description": "Storage URL to download retrieve diagnostics data files", + "name": "url", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {} + ], + "since": "4.14.0.0" + }, + { + "description": "Deletes a autoscale vm group.", + "isasync": true, + "name": "deleteAutoScaleVmGroup", + "params": [ { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, - {}, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" - }, - {}, + "description": "true if all VMs have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.18.0", + "type": "boolean" + } + ], + "response": [ { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { - "description": "Adds a netscaler control center device", - "isasync": true, - "name": "registerNetscalerControlCenter", + "description": "lists Palo Alto firewall devices in a physical network", + "isasync": false, + "name": "listPaloAltoFirewalls", "params": [ { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,listPaloAltoFirewalls", + "required": false, + "type": "uuid" + }, + { + "description": "the Physical Network ID", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "List by keyword", "length": 255, - "name": "username", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "", "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "", "length": 255, - "name": "numretries", - "required": true, + "name": "page", + "required": false, "type": "integer" } ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "related": "addPaloAltoFirewall", "response": [ { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { @@ -120557,18 +129427,23 @@ "type": "string" }, { - "description": "the management IP address of the external load balancer", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, + { + "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { @@ -120577,2497 +129452,2298 @@ "type": "integer" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "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": "device name", + "name": "fwdevicename", "type": "string" }, { "description": "device capacity", - "name": "lbdevicecapacity", + "name": "fwdevicecapacity", "type": "long" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the private security zone of the external firewall", + "name": "privatezone", "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 Palo Alto firewall belongs to", + "name": "physicalnetworkid", + "type": "string" }, - {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" } ] }, { - "description": "Lists image stores.", - "isasync": false, - "name": "listImageStores", + "description": "Updates load balancer", + "isasync": true, + "name": "updateLoadBalancerRule", "params": [ { - "description": "the image store protocol", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, - { - "description": "the ID of the storage pool", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "id", - "related": "listImageStores", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "the image store provider", + "description": "The protocol for the LB", "length": 255, - "name": "provider", + "name": "protocol", "required": false, "type": "string" }, { - "description": "read-only status of the image store", - "length": 255, - "name": "readonly", - "related": "listImageStores", - "required": false, - "since": "4.15.0", - "type": "boolean" - }, - { - "description": "List by keyword", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "keyword", + "name": "algorithm", "required": false, "type": "string" }, { - "description": "", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "page", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the image store", + "description": "the name of the load balancer rule", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "the ID of the load balancer rule to update", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, + "name": "id", + "related": "", + "required": true, "type": "uuid" } ], - "related": "", + "related": "listLoadBalancerRules", "response": [ { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the ID of the image store", - "name": "id", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, - {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, { - "description": "the url of the image store", - "name": "url", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the image store", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, - {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ], - "since": "4.2.0" - }, - { - "description": "Deletes a account, and all users associated with this account", - "isasync": true, - "name": "deleteAccount", - "params": [ - { - "description": "Account id", - "length": 255, + "description": "the load balancer rule ID", "name": "id", - "related": "enableAccount,listAccounts", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the public port", + "name": "publicport", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "Adds metric counter for VM auto scaling", - "isasync": true, - "name": "createCounter", - "params": [ { - "description": "Value of the counter e.g. oid in case of snmp.", - "length": 255, - "name": "value", - "required": true, + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "Source of the counter.", - "length": 255, - "name": "source", - "required": true, - "type": "string" + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" }, + {}, { - "description": "Name of the counter.", - "length": 255, + "description": "the name of the load balancer", "name": "name", - "required": true, "type": "string" }, { - "description": "Network provider of the counter.", - "length": 255, - "name": "provider", - "required": true, - "since": "4.18.0", + "description": "the private port", + "name": "privateport", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the Counter", - "name": "id", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "Source of the counter.", - "name": "source", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "Provider of the counter.", - "name": "provider", + "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": "zone id of counter", - "name": "zoneid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "Name of the counter.", - "name": "name", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address", + "name": "publicip", "type": "string" } ] }, { - "description": "List Event Types", + "description": "Delete one or more alerts.", "isasync": false, - "name": "listEventTypes", - "params": [], - "related": "", - "response": [ + "name": "deleteAlerts", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the IDs of the alerts", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" }, - {}, { - "description": "Event Type", - "name": "name", - "type": "string" + "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, - {} - ] - }, - { - "description": "Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted", - "isasync": false, - "name": "prepareForShutdown", - "params": [ { - "description": "the uuid of the management server", + "description": "delete by alert type", "length": 255, - "name": "managementserverid", - "related": "", - "required": true, - "type": "uuid" + "name": "type", + "required": false, + "type": "string" } ], - "related": "", "response": [ { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - }, - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "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": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.19.0" + }, + {}, + {} + ] }, { - "description": "Disables out-of-band management for a cluster", - "isasync": true, - "name": "disableOutOfBandManagementForCluster", + "description": "Enables an account", + "isasync": false, + "name": "enableAccount", "params": [ { - "description": "the ID of the cluster", + "description": "Account id", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, + "name": "id", + "related": "enableAccount,listAccounts", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "listAccounts", + "response": [ { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, {}, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - } - ], - "since": "4.9.0" - }, - { - "description": "Adds a new cluster", - "isasync": false, - "name": "addCluster", - "params": [ - { - "description": "the Zone ID for the cluster", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { - "description": "Ovm3 vip to use for pool (and cluster)", - "length": 255, - "name": "ovm3vip", - "required": false, + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the username for the cluster", - "length": 255, - "name": "username", - "required": false, + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", - "length": 255, - "name": "publicvswitchtype", - "required": false, + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", - "length": 255, - "name": "clustertype", - "required": true, + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", - "length": 255, - "name": "ovm3cluster", - "required": false, - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the username for the VSM associated with this cluster", - "length": 255, - "name": "vsmusername", - "required": false, + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": true, + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", - "length": 255, - "name": "publicvswitchname", - "required": false, + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", - "length": 255, - "name": "guestvswitchtype", - "required": false, + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, + {}, { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", - "length": 255, - "name": "guestvswitchname", - "required": false, - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", - "length": 255, - "name": "ovm3pool", - "required": false, - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the password for the VSM associated with this cluster", - "length": 255, - "name": "vsmpassword", - "required": false, - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the ipaddress of the VSM associated with this cluster", - "length": 255, - "name": "vsmipaddress", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the URL", - "length": 255, - "name": "url", - "required": false, + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" } ], "type": "list" }, { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the cluster ID", - "name": "id", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "the type of the cluster", - "name": "clustertype", + "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": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" - } - ] - }, - { - "description": "Deletes an traffic monitor host.", - "isasync": false, - "name": "deleteTrafficMonitor", - "params": [ + }, { - "description": "Id of the Traffic Monitor Host.", - "length": 255, - "name": "id", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the account", + "name": "state", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, - {} - ] - }, - { - "description": "Removes VM from specified network by deleting a NIC", - "isasync": true, - "name": "removeNicFromVirtualMachine", - "params": [ { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" - } - ], - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" - }, + } + ] + }, + { + "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", + "isasync": true, + "name": "createAutoScaleVmProfile", + "params": [ { - "description": "the account associated with the virtual machine", + "description": "account that will own the autoscale VM profile", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "domain ID of the account owning a autoscale VM profile", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, - {}, - {}, { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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 project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "getUser", + "required": false, + "type": "uuid" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18.1", + "type": "map" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "an optional project for the autoscale VM profile", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is expunged", + "length": 255, + "name": "expungevmgraceperiod", + "required": false, + "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the service offering of the auto deployed virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the template of the auto deployed virtual machine", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18.1", + "type": "uuid" }, { - "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 profile to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "length": 255, + "name": "counterparam", + "required": false, + "type": "map" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "type": "map" + } + ], + "related": "", + "response": [ + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "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 description of the affinity group", - "name": "description", - "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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "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 account owning the instance group", + "name": "account", + "type": "string" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the project id of the vm", + "description": "the project id vm profile", "name": "projectid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Base 64 encoded VM user data", + "name": "userdata", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", + "type": "string" }, {}, { - "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 ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "is profile for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + } + ] + }, + { + "description": "Register the OAuth2 provider in CloudStack", + "isasync": false, + "name": "registerOauthProvider", + "params": [ { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Client ID pre-registered in the specific OAuth provider", + "length": 255, + "name": "clientid", + "required": true, + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", + "length": 255, + "name": "provider", + "required": true, + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Redirect URI pre-registered in the specific OAuth provider", + "length": 255, + "name": "redirecturi", + "required": true, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": true, "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", + "required": true, "type": "string" - }, + } + ], + "response": [ { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Lists load balancer stickiness policies.", + "isasync": false, + "name": "listLBStickinessPolicies", + "params": [ { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the load balancer stickiness policy", + "length": 255, + "name": "id", + "related": "listLBStickinessPolicies", + "required": false, + "type": "uuid" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the ID of the nic", + "description": "the LB Stickiness policy ID", "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "is policy for display to the regular user", + "name": "fordisplay", "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" } ], - "type": "set" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "type": "list" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, + {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - } - ], - "type": "set" + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Adds a Ucs manager", + "isasync": false, + "name": "addUcsManager", + "params": [ + { + "description": "the name of UCS url", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of UCS manager", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the Zone id for the ucs manager", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the username of UCS", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the password of UCS", + "length": 255, + "name": "password", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the ucs manager", + "name": "id", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the url of ucs manager", + "name": "url", + "type": "string" + } + ] + }, + { + "description": "Deletes a network", + "isasync": true, + "name": "deleteNetwork", + "params": [ + { + "description": "the ID of the network", + "length": 255, + "name": "id", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 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": "Activates a project", + "description": "Reconnects a host.", "isasync": true, - "name": "activateProject", + "name": "reconnectHost", "params": [ { - "description": "id of the project to be modified", + "description": "the host ID", "length": 255, "name": "id", - "related": "activateProject", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "", + "related": "addBaremetalHost", "response": [ { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, - {}, { - "description": "the state of the project", - "name": "state", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, + {}, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - {}, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the id of the project", - "name": "id", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + {}, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "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 vpcs owned by project", - "name": "vpctotal", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" } - ], - "since": "3.0.0" + ] }, { - "description": "Delete a certificate to CloudStack", - "isasync": false, - "name": "deleteSslCert", + "description": "Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.", + "isasync": true, + "name": "deleteVnfTemplate", "params": [ { - "description": "Id of SSL certificate", + "description": "the ID of the template", "length": 255, "name": "id", - "related": "uploadSslCert", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" + }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] + {} + ], + "since": "4.19.0" }, { - "description": "Lists dedicated hosts.", - "isasync": false, - "name": "listDedicatedHosts", + "description": "Starts a stopped CloudManaged Kubernetes cluster", + "isasync": true, + "name": "startKubernetesCluster", "params": [ { - "description": "list dedicated hosts by affinity group", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, + "name": "id", + "related": "startKubernetesCluster", + "required": true, "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, + {}, { - "description": "the name of the account associated with the host. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": false, - "type": "uuid" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the host", - "length": 255, + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, - {}, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" } ] }, { - "description": "Get diagnostics and files from system VMs", + "description": "Deletes a project", "isasync": true, - "name": "getDiagnosticsData", + "name": "deleteProject", "params": [ { - "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "description": "id of the project to be deleted", "length": 255, - "name": "targetid", + "name": "id", "related": "", "required": true, "type": "uuid" }, { - "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", + "description": "true if all project resources have to be cleaned up, false otherwise", "length": 255, - "name": "files", + "name": "cleanup", "required": false, - "type": "list" + "since": "4.16.0", + "type": "boolean" } ], - "related": "", "response": [ { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ], - "since": "4.14.0.0" + "since": "3.0.0" }, { - "description": "upload an existing ISO into the CloudStack cloud.", + "description": "lists netscaler load balancer devices", "isasync": false, - "name": "getUploadParamsForIso", + "name": "listNetscalerLoadBalancers", "params": [ { - "description": "the name of the volume/template", + "description": "netscaler load balancer device ID", "length": 255, - "name": "name", - "required": true, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "", "length": 255, - "name": "isextractable", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the zone you wish to register the ISO to.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, "type": "uuid" + } + ], + "related": "addNetscalerLoadBalancer", + "response": [ + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", - "length": 255, - "name": "bootable", - "required": false, + "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": "device state", + "name": "lbdevicestate", + "type": "string" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", "type": "boolean" }, + {}, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, + {}, { - "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": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "the name of the ISO", - "length": 255, - "name": "name", - "required": true, + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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, + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + } + ] + }, + { + "description": "Creates a vm group", + "isasync": false, + "name": "createInstanceGroup", + "params": [ + { + "description": "The project of the instance group", "length": 255, - "name": "ostypeid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "Upload volume/template for the project", + "description": "the domain ID of account owning the instance group", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "format", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the name of the instance group", + "length": 255, + "name": "name", "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "true if you want this ISO to be featured", - "length": 255, - "name": "isfeatured", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "related": "", - "response": [ + }, + {}, + {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { @@ -123076,132 +131752,153 @@ "type": "string" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the instance group", + "name": "id", + "type": "string" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the project name of the instance group", + "name": "project", + "type": "string" } - ], - "since": "4.13" + ] }, { - "description": "Deletes a autoscale vm group.", - "isasync": true, - "name": "deleteAutoScaleVmGroup", + "description": "List iso visibility and all accounts that have permissions to view this iso.", + "isasync": false, + "name": "listIsoPermissions", "params": [ { - "description": "the ID of the autoscale group", + "description": "the template ID", "length": 255, "name": "id", - "related": "", + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "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" } ], + "related": "listTemplatePermissions,listIsoPermissions", "response": [ + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the template ID", + "name": "id", + "type": "string" }, {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "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", + "type": "string" + } ] }, { - "description": "lists Palo Alto firewall devices in a physical network", - "isasync": false, - "name": "listPaloAltoFirewalls", + "description": "Adds a netscaler load balancer device", + "isasync": true, + "name": "addNetscalerLoadBalancer", "params": [ { - "description": "", + "description": "public IP of the site", "length": 255, - "name": "pagesize", + "name": "gslbproviderpublicip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "true if NetScaler device being added is for providing GSLB service", "length": 255, - "name": "page", + "name": "gslbprovider", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "URL of the netscaler load balancer appliance.", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "private IP of the site", + "length": 255, + "name": "gslbproviderprivateip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Palo Alto firewall device ID", + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", + "name": "networkdevicetype", + "required": true, + "type": "string" + }, + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "length": 255, + "name": "isexclusivegslbprovider", "required": false, + "type": "boolean" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "keyword", - "required": false, + "name": "username", + "required": true, "type": "string" } ], - "related": "addPaloAltoFirewall", + "related": "", "response": [ - {}, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -123209,110 +131906,119 @@ "type": "integer" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "device state", - "name": "fwdevicestate", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the public interface of the external firewall", + "description": "the public interface of the load balancer", "name": "publicinterface", "type": "string" }, - {}, - { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" - }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { "description": "device capacity", - "name": "fwdevicecapacity", + "name": "lbdevicecapacity", "type": "long" }, + {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" } ] }, { - "description": "Updates load balancer", + "description": "Creates an internal load balancer", "isasync": true, - "name": "updateLoadBalancerRule", + "name": "createLoadBalancer", "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" + "description": "the source port the network traffic will be load balanced from", + "length": 255, + "name": "sourceport", + "required": true, + "type": "integer" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "algorithm", - "required": false, - "type": "string" + "name": "instanceport", + "required": true, + "type": "integer" }, { - "description": "the name of the load balancer rule", + "description": "the network id of the source ip address", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "sourceipaddressnetworkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The guest network the load balancer will be created for", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" }, { @@ -123324,46 +132030,130 @@ "type": "boolean" }, { - "description": "the ID of the load balancer rule to update", + "description": "the description of the load balancer", + "length": 4096, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "id", - "related": "", + "name": "scheme", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The protocol for the LB", + "description": "the source IP address the network traffic will be load balanced from", "length": 255, - "name": "protocol", + "name": "sourceipaddress", "required": false, "type": "string" + }, + { + "description": "name of the load balancer", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], - "related": "listLoadBalancerRules", + "related": "", "response": [ { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the description of the load balancer", + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, + { + "description": "the instance ID", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the description of the Load Balancer", "name": "description", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { @@ -123372,27 +132162,32 @@ "type": "integer" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -123401,23 +132196,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -123426,621 +132221,729 @@ "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 account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the public ip address", - "name": "publicip", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { - "description": "the domain of the load balancer rule", + "description": "the domain of the Load Balancer", "name": "domain", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Removes network permissions.", + "isasync": false, + "name": "removeNetworkPermissions", + "params": [ { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" }, { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "", + "required": false, + "type": "list" }, { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accountids", + "related": "listAccounts", + "required": false, + "type": "list" + } + ], + "response": [ + {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "config Tungsten-Fabric service", + "isasync": false, + "name": "configTungstenFabricService", + "params": [ + { + "description": "the ID of physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "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 load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Delete one or more alerts.", + "description": "list baremetal pxe server", "isasync": false, - "name": "deleteAlerts", + "name": "listBaremetalPxeServers", "params": [ { - "description": "the IDs of the alerts", + "description": "the Physical Network ID", "length": 255, - "name": "ids", + "name": "physicalnetworkid", "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "Pxe server device ID", "length": 255, - "name": "startdate", + "name": "id", "required": false, - "type": "date" + "type": "long" }, { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "delete by alert type", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" } ], + "related": "", "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "url", + "name": "url", "type": "string" }, - {} + {}, + { + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + } ] }, { - "description": "Enables an account", - "isasync": false, - "name": "enableAccount", + "description": "Adds a Palo Alto firewall device", + "isasync": true, + "name": "addPaloAltoFirewall", "params": [ { - "description": "Enables specified account in this domain.", + "description": "the Physical Network ID", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "physicalnetworkid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "Account id", + "description": "URL of the Palo Alto appliance.", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", - "required": false, - "type": "uuid" + "name": "url", + "required": true, + "type": "string" }, { - "description": "Enables specified account.", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "account", - "required": false, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "Credentials to reach Palo Alto firewall device", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "supports only PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": true, "type": "string" } ], - "related": "listAccounts", + "related": "", "response": [ { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" + }, + { + "description": "the public interface of the external firewall", + "name": "publicinterface", + "type": "string" + }, + {}, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" + }, + { + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" + }, + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + { + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" + }, + { + "description": "device capacity", + "name": "fwdevicecapacity", "type": "long" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "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 total volume available for this account", - "name": "volumeavailable", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + {} + ] + }, + { + "description": "Creates a private gateway", + "isasync": true, + "name": "createPrivateGateway", + "params": [ + { + "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "length": 255, + "name": "sourcenatsupported", + "required": false, + "type": "boolean" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the network implementation uri for the private gateway", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" + }, + { + "description": "The isolated network this private gateway is associated to.", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "since": "4.17.0", + "type": "uuid" + }, + { + "description": "the gateway of the Private gateway", + "length": 255, + "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": "uuid" + }, + { + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "length": 255, + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" + }, + { + "description": "the Physical Network ID the network belongs to", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the IP address of the Private gateaway", + "length": 255, + "name": "ipaddress", + "required": true, + "type": "string" + }, + { + "description": "the netmask of the Private gateway", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" + } + ], + "related": "createPrivateGateway,listPrivateGateways", + "response": [ + { + "description": "the id of the private gateway", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the private gateway", + "name": "projectid", + "type": "string" + }, + { + "description": "zone id of the private gateway", + "name": "zoneid", + "type": "string" + }, + { + "description": "the private gateway's netmask", + "name": "netmask", + "type": "string" + }, + {}, + { + "description": "ACL Id set for private gateway", + "name": "aclid", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "Source Nat enable status", + "name": "sourcenatsupported", "type": "boolean" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "ACL name set for private gateway", + "name": "aclname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the network implementation uri for the private gateway", + "name": "vlan", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "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", + "type": "string" + }, + { + "description": "the gateway", + "name": "gateway", "type": "string" }, {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "4.17.0" + }, + { + "description": "Find user account by API key", + "isasync": false, + "name": "getUser", + "params": [ { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "API key of the user", + "length": 255, + "name": "userapikey", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the id of the account", - "name": "id", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - } + {} ] }, { - "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", - "isasync": true, - "name": "createAutoScaleVmProfile", + "description": "Lists load balancer rules.", + "isasync": false, + "name": "listLoadBalancerRules", "params": [ { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, "name": "fordisplay", "required": false, @@ -124048,76 +132951,58 @@ "type": "boolean" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, "type": "uuid" }, { - "description": "the time allowed for existing connections to get closed before a vm is expunged", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "expungevmgraceperiod", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "the name of the load balancer rule", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "the ID of the load balancer rule", "length": 255, - "name": "autoscaleuserid", - "related": "getUser", + "name": "id", + "related": "", "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": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "", "length": 255, - "name": "counterparam", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "account that will own the autoscale VM profile", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "an optional project for the autoscale VM profile", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "", + "name": "isrecursive", "required": false, - "type": "uuid" - }, - { - "description": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "domain ID of the account owning a autoscale VM profile", + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -124125,315 +133010,192 @@ "type": "uuid" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "", "length": 255, - "name": "otherdeployparams", + "name": "page", "required": false, - "type": "map" - } - ], - "related": "", - "response": [ - { - "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 template to be used while deploying a virtual machine", - "name": "templateid", - "type": "string" - }, - {}, - { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", "type": "integer" }, - {}, - { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - {}, - { - "description": "Base 64 encoded VM user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, - { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" - } - ] - }, - { - "description": "Lists load balancer stickiness policies.", - "isasync": false, - "name": "listLBStickinessPolicies", - "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the availability zone ID", "length": 255, - "name": "fordisplay", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "pagesize", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "id", - "related": "listLBStickinessPolicies", + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "required": false, "type": "uuid" }, { - "description": "List 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": "the ID of the load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "lbruleid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the domain of the Stickiness policy", - "name": "domain", - "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 account of the Stickiness policy", + "description": "the account of the load balancer rule", "name": "account", "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 list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "the list of resource tags associated with load balancer", + "name": "tags", "response": [ { - "description": "the state of the policy", - "name": "state", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "list" }, - {}, { - "description": "the 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 Stickiness policy", - "name": "domainid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", + "description": "the id of the zone the rule belongs to", "name": "zoneid", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Adds a Ucs manager", - "isasync": false, - "name": "addUcsManager", - "params": [ { - "description": "the username of UCS", - "length": 255, - "name": "username", - "required": true, + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the name of UCS url", - "length": 255, - "name": "url", - "required": true, + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the name of UCS manager", - "length": 255, + "description": "the name of the load balancer", "name": "name", - "required": false, "type": "string" }, { - "description": "the password of UCS", - "length": 255, - "name": "password", - "required": true, + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the Zone id for the ucs manager", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { - "description": "the name of ucs manager", - "name": "name", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the url of ucs manager", - "name": "url", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -124442,699 +133204,804 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes a network", - "isasync": true, - "name": "deleteNetwork", - "params": [ - { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the private port", + "name": "privateport", + "type": "string" }, { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the load balancer", + "name": "project", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" } ] }, { - "description": "Reconnects a host.", + "description": "Deletes a firewall rule", "isasync": true, - "name": "reconnectHost", + "name": "deleteFirewallRule", "params": [ { - "description": "the host ID", + "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "addBaremetalHost,reconnectHost", + "related": "", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost", "response": [ { "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 host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Upload a certificate to CloudStack", + "isasync": false, + "name": "uploadSslCert", + "params": [ { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "Password for the private key", + "length": 255, + "name": "password", + "required": false, + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "Enables revocation checking for certificates", + "length": 255, + "name": "enabledrevocationcheck", + "required": false, + "since": "4.15", "type": "boolean" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "an optional project for the SSL certificate", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", + "required": false, "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "certificate fingerprint", + "name": "fingerprint", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the project id of the certificate", + "name": "projectid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "account for the certificate", + "name": "account", "type": "string" }, + {}, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "certificate chain", + "name": "certchain", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "SSL certificate ID", + "name": "id", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, + {}, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Updates the registered OAuth provider details", + "isasync": false, + "name": "updateOauthProvider", + "params": [ { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", + "required": false, "type": "string" }, - {}, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "Redirect URI pre-registered in the specific OAuth provider", + "length": 255, + "name": "redirecturi", + "required": false, "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "id of the OAuth provider to be updated", + "length": 255, + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "OAuth provider will be enabled or disabled based on this value", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, + "description": "Client ID pre-registered in the specific OAuth provider", + "length": 255, + "name": "clientid", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "Name of the provider", + "name": "name", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Description of the provider registered", + "name": "description", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "Name of the provider", + "name": "provider", + "type": "string" }, + {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Creates site to site vpn customer gateway", + "isasync": true, + "name": "createVpnCustomerGateway", + "params": [ { - "description": "capabilities of the host", - "name": "capabilities", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "length": 255, + "name": "ipsecpsk", + "required": true, "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "ikelifetime", + "required": false, "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", + "required": false, + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "length": 255, + "name": "ikeversion", + "required": false, + "since": "4.15.1", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "IKE policy of the customer gateway", + "length": 255, + "name": "ikepolicy", + "required": true, "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": "create site-to-site VPN customer gateway for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "since": "4.6", + "type": "uuid" }, { - "description": "the host version", - "name": "version", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": true, "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "name of this customer gateway", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "Force Encapsulation for NAT traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "length": 255, + "name": "splitconnections", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - } - ] - }, - { - "description": "Starts a stopped CloudManaged Kubernetes cluster", - "isasync": true, - "name": "startKubernetesCluster", - "params": [ + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { - "description": "the ID of the Kubernetes cluster", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "id", - "related": "startKubernetesCluster", + "name": "gateway", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id of the owner", "name": "domainid", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, + {}, + {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, - {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Creates a Management network IP range.", + "isasync": true, + "name": "createManagementNetworkIpRange", + "params": [ { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "The gateway for the management network.", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The netmask for the management network.", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Specify if range is dedicated for CPVM and SSVM.", + "length": 255, + "name": "forsystemvms", + "required": false, "type": "boolean" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "The ending IP address.", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "The starting IP address.", + "length": 255, + "name": "startip", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", + "length": 255, + "name": "vlan", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the name of the Pod", + "name": "name", + "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + } + ], + "type": "list" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "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 service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" - } - ] - }, - { - "description": "Deletes a project", - "isasync": true, - "name": "deleteProject", - "params": [ + }, { - "description": "true if all project resources have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.16.0", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "id of the project to be deleted", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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" } ], - "since": "3.0.0" + "since": "4.11.0.0" }, { - "description": "lists netscaler load balancer devices", + "description": "Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster", "isasync": false, - "name": "listNetscalerLoadBalancers", + "name": "listCiscoNexusVSMs", "params": [ { "description": "", @@ -125144,24 +134011,17 @@ "type": "integer" }, { - "description": "netscaler load balancer device ID", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the Physical Network ID", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "physicalnetworkid", + "name": "clusterid", "related": "", "required": false, "type": "uuid" @@ -125172,39 +134032,42 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "addNetscalerLoadBalancer", + "related": "", "response": [ { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, + {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - { - "description": "device state", - "name": "lbdevicestate", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "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": "the current status of the latest async job acting on this object", @@ -125212,277 +134075,309 @@ "type": "integer" }, { - "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": "device name", - "name": "lbdevicename", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, {}, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "device name", + "name": "vsmdevicename", + "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" } ] }, { - "description": "Creates a vm group", - "isasync": false, - "name": "createInstanceGroup", + "description": "Adds vpn users", + "isasync": true, + "name": "addVpnUser", "params": [ { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the name of the instance group", + "description": "password for the username", "length": 255, - "name": "name", + "name": "password", "required": true, "type": "string" }, { - "description": "the domain ID of account owning the instance group", + "description": "add vpn user to the specific project", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "The project of the instance group", + "description": "username for the vpn user", "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the ID of the instance group", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, + {}, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, - { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, {}, { - "description": "the project name of the instance group", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the instance group", + "description": "the domain id of the account of the remote access vpn", "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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 account owning the instance group", - "name": "account", + "description": "the vpn userID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" } ] }, { - "description": "List iso visibility and all accounts that have permissions to view this iso.", + "description": "remove an annotation.", "isasync": false, - "name": "listIsoPermissions", + "name": "removeAnnotation", "params": [ { - "description": "the template ID", + "description": "the id of the annotation", "length": 255, "name": "id", - "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "listTemplatePermissions,listIsoPermissions", + "related": "", "response": [ + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, - {}, { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" + }, + { + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, + { + "description": "the 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" } - ] + ], + "since": "4.11" }, { - "description": "Adds a netscaler load balancer device", - "isasync": true, - "name": "addNetscalerLoadBalancer", + "description": "add a baremetal host", + "isasync": false, + "name": "addBaremetalHost", "params": [ { - "description": "public IP of the site", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "gslbproviderpublicip", + "name": "username", "required": false, "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, "name": "password", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the host URL", + "length": 255, + "name": "url", "required": true, "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "description": "the cluster ID for the host", "length": 255, - "name": "isexclusivegslbprovider", + "name": "clusterid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "the Pod ID for the host", "length": 255, - "name": "physicalnetworkid", + "name": "podid", "related": "", "required": true, "type": "uuid" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "hypervisor type of the host", "length": 255, - "name": "username", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "gslbprovider", + "name": "ipaddress", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "description": "list of tags to be added to the host", "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" + "name": "hosttags", + "required": false, + "type": "list" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "the cluster name for the host", "length": 255, - "name": "url", - "required": true, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "private IP of the site", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "gslbproviderprivateip", + "name": "allocationstate", "required": false, "type": "string" } @@ -125490,513 +134385,410 @@ "related": "", "response": [ { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, - {}, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, + {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "device capacity", - "name": "lbdevicecapacity", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - } - ] - }, - { - "description": "Creates an internal load balancer", - "isasync": true, - "name": "createLoadBalancer", - "params": [ + "description": "the host version", + "name": "version", + "type": "string" + }, { - "description": "the network id of the source ip address", - "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "The guest network the load balancer will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "instanceport", - "required": true, + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the source port the network traffic will be load balanced from", - "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "name of the load balancer", - "length": 255, - "name": "name", - "required": true, + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", - "required": false, - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the source IP address the network traffic will be load balanced from", - "length": 255, - "name": "sourceipaddress", - "required": false, + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", - "length": 255, - "name": "scheme", - "required": true, + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - {}, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the name of the instance", - "name": "name", - "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the instance ID", - "name": "id", - "type": "string" - } - ], - "type": "list" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "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 load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ - { - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, + {}, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - } - ], - "type": "list" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "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 project name of the Load Balancer", - "name": "project", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "List backup schedule of a VM", - "isasync": false, - "name": "listBackupSchedule", - "params": [ - { - "description": "ID of the VM", - "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": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "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": "name of the VM", - "name": "virtualmachinename", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "time the backup is scheduled to be taken.", - "name": "schedule", + "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 host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "ID of the VM", - "name": "virtualmachineid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the interval type of the backup schedule", - "name": "intervaltype", - "type": "intervaltype" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, - {}, { - "description": "the time zone of the backup schedule", - "name": "timezone", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, - {} - ], - "since": "4.14.0" - }, - { - "description": "Restore and attach a backed up volume to VM", - "isasync": true, - "name": "restoreVolumeFromBackupAndAttachToVM", - "params": [ { - "description": "ID of the volume backed up", - "length": 255, - "name": "volumeid", - "required": true, + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "id of the VM where to attach the restored volume", - "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": true, - "type": "uuid" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "ID of the VM backup", - "length": 255, - "name": "backupid", - "related": "updateBackupSchedule", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, - {}, - {} - ], - "since": "4.14.0" + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + } + ] }, { - "description": "Removes network permissions.", + "description": "Deletes a project role permission in the project", "isasync": false, - "name": "removeNetworkPermissions", + "name": "deleteProjectRolePermission", "params": [ { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "ID of the project role permission to be deleted", "length": 255, - "name": "projectids", + "name": "id", "related": "", - "required": false, - "type": "list" - }, - { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accounts", - "required": false, - "type": "list" - }, - { - "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" + "required": true, + "type": "uuid" }, { - "description": "the network ID", + "description": "ID of the project where the project role permission is to be deleted", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "projectid", + "related": "", "required": true, "type": "uuid" } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -126005,334 +134797,235 @@ "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" }, {} ], - "since": "4.17.0" + "since": "4.15.0" }, { - "description": "config Tungsten-Fabric service", + "description": "Deletes a role permission", "isasync": false, - "name": "configTungstenFabricService", + "name": "deleteRolePermission", "params": [ { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of physical network", + "description": "ID of the role permission", "length": 255, - "name": "physicalnetworkid", + "name": "id", "related": "", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "the UUID of the latest async job acting on 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.9.0" }, { - "description": "Updates a user-defined VM backup schedule", + "description": "Updates the quarantine end date for the given public IP address.", "isasync": false, - "name": "updateBackupSchedule", + "name": "updateQuarantinedIp", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "The date when the quarantine will no longer be active.", "length": 255, - "name": "timezone", + "name": "enddate", "required": true, - "type": "string" + "type": "date" }, { - "description": "custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)", + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", "length": 255, - "name": "schedule", - "required": true, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "The ID of the public IP address in active quarantine.", "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": true, + "name": "id", + "related": "updateQuarantinedIp", + "required": false, "type": "uuid" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, - "type": "string" } ], "related": "", "response": [ + {}, { - "description": "backup offering name", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "backed up volumes", - "name": "volumes", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone name", - "name": "zone", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, + {}, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, - { - "description": "backup status", - "name": "status", - "type": "status" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "account id", - "name": "accountid", - "type": "string" - }, - { - "description": "ID of the VM backup", - "name": "id", - "type": "string" - }, - { - "description": "external backup id", - "name": "externalid", - "type": "string" - }, - { - "description": "backup type", - "name": "type", - "type": "string" - }, - { - "description": "backup size in bytes", - "name": "size", - "type": "long" - }, - { - "description": "domain name", - "name": "domain", - "type": "string" - }, { - "description": "backup offering id", - "name": "backupofferingid", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { - "description": "zone id", - "name": "zoneid", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" - }, - { - "description": "backup date", + "description": "When the quarantine was created.", "name": "created", - "type": "string" + "type": "date" }, { - "description": "domain id", - "name": "domainid", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, { - "description": "account name", - "name": "account", - "type": "string" + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" - }, - {} + } ], - "since": "4.14.0" + "since": "4.19" }, { - "description": "list baremetal pxe server", + "description": "Update VM Schedule.", "isasync": false, - "name": "listBaremetalPxeServers", + "name": "updateVMSchedule", "params": [ { - "description": "", + "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "page", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "", + "description": "Name of the schedule", "length": 255, - "name": "pagesize", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Pxe server device ID", + "description": "Enable VM schedule", "length": 255, - "name": "id", + "name": "enabled", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "ID of VM schedule", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "id", + "related": "updateVMSchedule", "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", "length": 255, - "name": "keyword", + "name": "schedule", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "url", - "name": "url", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "device id of ", - "name": "id", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, - {} - ] - }, - { - "description": "Adds a Palo Alto firewall device", - "isasync": true, - "name": "addPaloAltoFirewall", - "params": [ { - "description": "Credentials to reach Palo Alto firewall device", - "length": 255, - "name": "password", - "required": true, - "type": "string" + "description": "Action", + "name": "action", + "type": "action" }, { - "description": "URL of the Palo Alto appliance.", - "length": 255, - "name": "url", - "required": true, + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, { - "description": "Credentials to reach Palo Alto firewall device", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, { - "description": "supports only PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { @@ -126341,527 +135034,512 @@ "type": "integer" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, - { - "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": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, + {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" - }, - { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Updates a template to VNF template or attributes of a VNF template.", + "isasync": false, + "name": "updateVnfTemplate", + "params": [ { - "description": "device name", - "name": "fwdevicename", - "type": "string" + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "length": 255, + "name": "cleanupvnfdetails", + "required": false, + "type": "boolean" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" }, - {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "length": 255, + "name": "vnfdetails", + "required": false, + "type": "map" }, { - "description": "device state", - "name": "fwdevicestate", - "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 number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - } - ] - }, - { - "description": "Creates a private gateway", - "isasync": true, - "name": "createPrivateGateway", - "params": [ - { - "description": "the netmask of the Private gateway", + "description": "the ID of the image file", "length": 255, - "name": "netmask", + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the VPC network belongs to", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" + "name": "requireshvm", + "required": false, + "type": "boolean" }, { - "description": "The isolated network this private gateway is associated to.", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "isrouting", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "boolean" }, { - "description": "the network implementation uri for the private gateway", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "vlan", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the Physical Network ID the network belongs to", + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "vnfnics", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the gateway of the Private gateway", + "description": "the format for the image", "length": 255, - "name": "gateway", - "required": true, + "name": "format", + "required": false, "type": "string" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "networkofferingid", - "related": "", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the IP address of the Private gateaway", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "sourcenatsupported", + "name": "cleanupvnfnics", "required": false, "type": "boolean" }, { - "description": "the ID of the network ACL", + "description": "the name of the image file", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "templatetype", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "createPrivateGateway", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "response": [ { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the gateway", - "name": "gateway", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the project id of the private gateway", - "name": "projectid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, - {}, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the name of the zone for this template", + "name": "zonename", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the project name of the private gateway", - "name": "project", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the account associated with the private gateway", - "name": "account", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "ACL name set for private gateway", - "name": "aclname", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, - {}, { - "description": "the id of the private gateway", - "name": "id", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", - "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Find user account by API key", - "isasync": false, - "name": "getUser", - "params": [ + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, { - "description": "API key of the user", - "length": 255, - "name": "userapikey", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "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", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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 name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, + {}, { - "description": "the account name of the user", - "name": "account", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "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 user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Lists load balancer rules.", + "description": "Lists all configuration groups (primarily used for UI).", "isasync": false, - "name": "listLoadBalancerRules", + "name": "listConfigurationGroups", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the virtual machine 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 name of the load balancer rule", + "description": "lists configuration group by group name", "length": 255, - "name": "name", + "name": "group", "required": false, "type": "string" }, - { - "description": "the public IP address ID of the load balancer rule", - "length": 255, - "name": "publicipid", - "related": "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": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, { "description": "", "length": 255, @@ -126869,29 +135547,6 @@ "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 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": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -126905,164 +135560,40 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "list by network ID the rule belongs to", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public 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 account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "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 domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" }, { - "description": "the list of resource tags associated with load balancer", - "name": "tags", + "description": "the subgroups of the configuration group", + "name": "subgroup", "response": [ { - "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": "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 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 precedence of the configuration subgroup", + "name": "precedence", + "type": "long" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the configuration subgroup", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the description of the configuration group", + "name": "description", "type": "string" }, - {}, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of the configuration group", + "name": "name", "type": "string" }, {}, @@ -127071,378 +135602,484 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" } - ] + ], + "since": "4.18.0" }, { - "description": "Deletes a firewall rule", - "isasync": true, - "name": "deleteFirewallRule", + "description": "Releases a Pod IP back to the Pod", + "isasync": false, + "name": "releasePodIpAddress", "params": [ { - "description": "the ID of the firewall rule", + "description": "UUID of the Pod IP", "length": 255, "name": "id", - "related": "", "required": true, - "type": "uuid" + "type": "long" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Upload a certificate to CloudStack", - "isasync": false, - "name": "uploadSslCert", + "description": "Updates VPC offering", + "isasync": true, + "name": "updateVPCOffering", "params": [ { - "description": "Private key", - "length": 16384, - "name": "privatekey", + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Password for the private key", + "description": "sort key of the VPC offering, integer", "length": 255, - "name": "password", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", + "description": "the name of the VPC offering", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "account that will own the SSL certificate", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "account", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "an optional project for the SSL certificate", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", "length": 255, - "name": "projectid", - "related": "", + "name": "state", "required": false, - "type": "uuid" - }, - { - "description": "SSL certificate", - "length": 16384, - "name": "certificate", - "required": true, "type": "string" }, { - "description": "domain ID of the account owning the SSL certificate", + "description": "the display text of the VPC offering", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "displaytext", "required": false, - "type": "uuid" - }, - { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", - "required": true, "type": "string" }, { - "description": "Enables revocation checking for certificates", - "length": 255, - "name": "enabledrevocationcheck", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "account for the certificate", - "name": "account", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", - "type": "string" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, - {}, { - "description": "SSL certificate ID", - "name": "id", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": "name", + "description": "the name of the vpc offering", "name": "name", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id of the certificate", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, + {}, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { - "description": "certificate", - "name": "certificate", + "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": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, - {}, { - "description": "certificate fingerprint", - "name": "fingerprint", + "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 project name of the certificate", - "name": "project", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "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": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, { - "description": "Creates site to site vpn customer gateway", + "description": "Updates remote access vpn", "isasync": true, - "name": "createVpnCustomerGateway", + "name": "updateRemoteAccessVpn", "params": [ { - "description": "Force Encapsulation for NAT traversal", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "forceencap", + "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": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "id of the remote access vpn", "length": 255, - "name": "ipsecpsk", + "name": "id", + "related": "updateRemoteAccessVpn", "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", - "length": 255, - "name": "ikeversion", - "required": false, - "since": "4.15.1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of this customer gateway", - "length": 255, - "name": "name", - "required": false, + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "esplifetime", - "required": false, - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, + {}, { - "description": "ESP policy of the customer gateway", - "length": 255, - "name": "esppolicy", - "required": true, + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" }, { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "ikelifetime", - "required": false, - "type": "long" + "description": "the id of the remote access vpn", + "name": "id", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": true, + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "create site-to-site VPN customer gateway for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "since": "4.6", - "type": "uuid" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.4" + }, + { + "description": "Lists user two factor authenticator providers", + "isasync": false, + "name": "listUserTwoFactorAuthenticatorProviders", + "params": [ + { + "description": "List user two factor authenticator provider by name", "length": 255, - "name": "gateway", - "required": true, + "name": "name", + "required": false, "type": "string" } ], "related": "", "response": [ { - "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": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the description of the user two factor authenticator provider", + "name": "description", "type": "string" }, - {}, { - "description": "name of the customer gateway", + "description": "the user two factor authenticator provider name", "name": "name", "type": "string" }, - { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ], + "since": "4.18.0" + }, + { + "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", + "isasync": true, + "name": "scaleVirtualMachine", + "params": [ + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": true, + "type": "uuid" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -127450,243 +136087,204 @@ "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", + "type": "string" }, + {} + ] + }, + { + "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", + "isasync": true, + "name": "destroyVirtualMachine", + "params": [ { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "Comma separated list of UUIDs for volumes that will be deleted", + "length": 255, + "name": "volumeids", + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "since": "4.12.0", + "type": "list" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "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 vpn gateway ID", + "description": "The ID of the virtual machine", + "length": 255, "name": "id", + "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "response": [ + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + {}, { - "description": "the project name", - "name": "project", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the project id", - "name": "projectid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" - } - ] - }, - { - "description": "Creates a Management network IP range.", - "isasync": true, - "name": "createManagementNetworkIpRange", - "params": [ + }, { - "description": "The ending IP address.", - "length": 255, - "name": "endip", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "The gateway for the management network.", - "length": 255, - "name": "gateway", - "required": true, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Specify if range is dedicated for CPVM and SSVM.", - "length": 255, - "name": "forsystemvms", - "required": false, + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "The netmask for the management network.", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", - "length": 255, - "name": "vlan", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the capacity type", + "description": "the type of the affinity group", "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the gateway for the range", - "name": "gateway", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -127695,515 +136293,968 @@ "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 backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the 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 allocation state of the Pod", - "name": "allocationstate", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {} - ], - "since": "4.11.0.0" - }, - { - "description": "Adds vpn users", - "isasync": true, - "name": "addVpnUser", - "params": [ { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, + "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": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "password for the username", - "length": 255, - "name": "password", - "required": true, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "add vpn user to the specific project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the vpn userID", - "name": "id", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the state of the Vpn User", - "name": "state", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" - } - ] - }, - { - "description": "Delete VM backup", - "isasync": true, - "name": "deleteBackup", - "params": [ - { - "description": "force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering", - "length": 255, - "name": "forced", - "required": false, - "since": "4.18.0.0", - "type": "boolean" }, { - "description": "id of the VM backup", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project name of the vm", + "name": "project", "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "remove an annotation.", - "isasync": false, - "name": "removeAnnotation", - "params": [ + }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": true, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, - {}, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the creation timestamp for this annotation", - "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": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "add a baremetal host", - "isasync": false, - "name": "addBaremetalHost", - "params": [ + }, { - "description": "the cluster ID for the host", - "length": 255, - "name": "clusterid", - "related": "", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster name for the host", - "length": 255, - "name": "clustername", - "required": false, + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "password", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "username", - "required": false, + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, + {}, + {}, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "", - "required": true, - "type": "uuid" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "ip address intentionally allocated to this host after provisioning", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "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" + } + ], + "type": "set" }, { - "description": "the ID of the host", - "name": "id", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "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 after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + } + ] + }, + { + "description": "Updates egress firewall rule ", + "isasync": true, + "name": "updateEgressFirewallRule", + "params": [ { - "description": "the name of the host", - "name": "name", - "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 last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the ID of the egress firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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 amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", @@ -128211,444 +137262,269 @@ "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 has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - {}, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the state of the host", + "description": "the state of the rule", "name": "state", - "type": "status" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the Pod ID of the host", - "name": "podid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, - { - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, + {} + ], + "since": "4.4" + }, + { + "description": "Lists all supported OS categories for this cloud.", + "isasync": false, + "name": "listOsCategories", + "params": [ { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - } - ] - }, - { - "description": "Deletes a project role permission in the project", - "isasync": false, - "name": "deleteProjectRolePermission", - "params": [ - { - "description": "ID of the project where the project role permission is to be deleted", + "description": "list Os category by id", "length": 255, - "name": "projectid", - "related": "", - "required": true, + "name": "id", + "related": "listOsCategories", + "required": false, "type": "uuid" }, { - "description": "ID of the project role permission to be deleted", + "description": "list os category by name", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "since": "3.0.1", + "type": "string" } ], + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the OS category", + "name": "id", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.15.0" - }, - { - "description": "Deletes a role permission", - "isasync": false, - "name": "deleteRolePermission", - "params": [ - { - "description": "ID of the role permission", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the OS category", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "Update VM Schedule.", + "description": "Lists all available service offerings.", "isasync": false, - "name": "updateVMSchedule", + "name": "listServiceOfferings", "params": [ { - "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "startdate", + "name": "page", "required": false, - "type": "date" + "type": "integer" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "enddate", + "name": "memory", "required": false, - "type": "date" + "since": "4.15", + "type": "integer" }, { - "description": "ID of VM schedule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "updateVMSchedule", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "schedule", + "name": "cpunumber", "required": false, - "type": "string" + "since": "4.15", + "type": "integer" }, { - "description": "Name of the schedule", + "description": "List by keyword", "length": 255, - "name": "description", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "timezone", + "name": "account", "required": false, "type": "string" }, { - "description": "Enable VM schedule", + "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": "enabled", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" - }, - { - "description": "Description of VM schedule", - "name": "description", - "type": "string" - }, - {}, - { - "description": "ID of virtual machine", "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": false, + "type": "uuid" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "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": "Cron formatted VM schedule", - "name": "schedule", + "description": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "the ID of VM schedule", + "description": "ID of the service offering", + "length": 255, "name": "id", - "type": "string" + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CPU speed that listed offerings must support", + "length": 255, + "name": "cpuspeed", + "required": false, + "since": "4.15", "type": "integer" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "listed offerings support root disk encryption", + "length": 255, + "name": "encryptroot", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "length": 255, + "name": "systemvmtype", + "required": false, + "type": "string" }, - {}, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists all configuration groups (primarily used for UI).", - "isasync": false, - "name": "listConfigurationGroups", - "params": [ { - "description": "List by keyword", + "description": "is this a system vm offering", "length": 255, - "name": "keyword", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -128658,32 +137534,38 @@ "type": "integer" }, { - "description": "lists configuration group by group name", + "description": "name of the service offering", "length": 255, - "name": "group", + "name": "name", "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": "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": "", + "related": "updateServiceOffering", "response": [ - {}, { - "description": "the description of the configuration group", - "name": "description", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -128691,643 +137573,628 @@ "type": "string" }, { - "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 precedence of the configuration group", - "name": "precedence", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the name of the configuration group", - "name": "name", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, - {} - ], - "since": "4.18.0" - }, - { - "description": "Releases a Pod IP back to the Pod", - "isasync": false, - "name": "releasePodIpAddress", - "params": [ { - "description": "UUID of the Pod IP", - "length": 255, - "name": "id", - "required": true, + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" - } - ], - "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": "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": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, - {} - ] - }, - { - "description": "Updates VPC offering", - "isasync": true, - "name": "updateVPCOffering", - "params": [ { - "description": "the display text of the VPC offering", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "sort key of the VPC offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", - "length": 255, - "name": "state", - "required": false, + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the id of the VPC offering", - "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the name of the VPC offering", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, + {}, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "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": "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": "the name of the vpc offering", - "name": "name", + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, - {}, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "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": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "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": "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 internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "the id of the service offering", + "name": "id", "type": "string" - } - ] - }, - { - "description": "Updates remote access vpn", - "isasync": true, - "name": "updateRemoteAccessVpn", - "params": [ + }, { - "description": "id of the remote access vpn", - "length": 255, - "name": "id", - "related": "updateRemoteAccessVpn", - "required": true, - "type": "uuid" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, + {}, { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the domain id of the account of the remote access vpn", + "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 public ip address of the vpn server", - "name": "publicip", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, + { + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, - {}, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "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 account of the remote access vpn", - "name": "account", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" } - ], - "since": "4.4" + ] }, { - "description": "Lists authorized users who can used SAML SSO", - "isasync": false, - "name": "listSamlAuthorization", + "description": "Import virtual machine from a unmanaged host into CloudStack", + "isasync": true, + "name": "importVm", "params": [ { - "description": "", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "page", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "User 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": "userid", - "related": "", + "name": "migrateallowed", "required": false, + "type": "boolean" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "", + "description": "(only for importing migrated VMs from Vmware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", "length": 255, - "name": "pagesize", + "name": "convertinstancehostid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "Host where local disk is located", "length": 255, - "name": "keyword", + "name": "hostid", + "related": "", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "type": "uuid" + }, { - "description": "the user ID", - "name": "userid", + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VM nic to network id mapping using keys nic and network", + "length": 255, + "name": "nicnetworklist", + "required": false, + "type": "map" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Source location for Import", + "length": 255, + "name": "importsource", + "required": true, "type": "string" }, - {}, { - "description": "the authorized Identity Provider ID", - "name": "idpid", + "description": "Temp Path on external host for disk image copy", + "length": 255, + "name": "temppath", + "required": false, "type": "string" }, { - "description": "the SAML authorization status", - "name": "status", - "type": "boolean" - } - ] - }, - { - "description": "Lists user two factor authenticator providers", - "isasync": false, - "name": "listUserTwoFactorAuthenticatorProviders", - "params": [ - { - "description": "List user two factor authenticator provider by name", + "description": "the username for the host", "length": 255, - "name": "name", + "name": "username", "required": false, "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the user two factor authenticator provider name", - "name": "name", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the description of the user two factor authenticator provider", - "name": "description", - "type": "string" + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Shared storage pool where disk is located", + "length": 255, + "name": "storageid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.18.0" - }, - { - "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", - "isasync": true, - "name": "scaleVirtualMachine", - "params": [ + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "details", + "name": "nicipaddresslist", "required": false, "type": "map" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": false, + "type": "string" + }, + { + "description": "the service offering for the virtual machine", "length": 255, "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "related": "updateServiceOffering", "required": true, "type": "uuid" }, { - "description": "The ID of the virtual machine", + "description": "the host name of the instance", "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": "hostname", + "required": false, + "type": "string" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware cluster.", "length": 255, - "name": "miniops", + "name": "clustername", "required": false, - "since": "4.17", - "type": "long" + "type": "string" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "(only for importing migrated VMs from Vmware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", "length": 255, - "name": "automigrate", + "name": "vcenter", "required": false, - "since": "4.17", - "type": "boolean" + "type": "string" }, { - "description": "Verify OK to Shrink", + "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", "length": 255, - "name": "shrinkok", + "name": "forced", "required": false, - "since": "4.17", "type": "boolean" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "maxiops", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "required": false, - "since": "4.17", - "type": "long" - } - ], - "response": [ + "type": "uuid" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "import instance for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "import instance to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "(only for importing migrated VMs from Vmware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", + "length": 255, + "name": "convertinstancepoolid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the display name of the instance", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" }, - {}, - {} - ] - }, - { - "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", - "isasync": true, - "name": "destroyVirtualMachine", - "params": [ { - "description": "Comma separated list of UUIDs for volumes that will be deleted", + "description": "path of the disk image", "length": 255, - "name": "volumeids", - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "diskpath", "required": false, - "since": "4.12.0", - "type": "list" + "type": "string" }, { - "description": "If true is passed, the vm is expunged immediately. False by default.", + "description": "(only for importing migrated VMs from Vmware to KVM) VMware ESXi host IP/Name.", "length": 255, - "name": "expunge", + "name": "hostip", "required": false, - "since": "4.2.1", - "type": "boolean" + "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "(only for importing migrated VMs from Vmware to KVM) UUID of a linked existing vCenter", "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, + "name": "existingvcenterid", + "related": "", + "required": false, "type": "uuid" } ], - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", "response": [ { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -129336,438 +138203,382 @@ "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, + {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "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 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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag value", + "name": "value", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project ID of the affinity group", + "name": "projectid", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Base64 string containing the user data", + "name": "userdata", "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": "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "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" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "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 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "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", @@ -129775,10 +138586,15 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -129792,28 +138608,63 @@ ], "type": "set" }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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" }, { @@ -129821,29 +138672,29 @@ "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", + "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": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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" }, { @@ -129851,18 +138702,23 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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", "type": "string" }, { @@ -129870,6 +138726,11 @@ "name": "key", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -129881,1096 +138742,392 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" }, - {}, { "description": "the vGPU type used by the virtual machine", "name": "vgpu", "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "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": "publicip", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "tag value", - "name": "value", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the 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 ID of the virtual machine", - "name": "id", - "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - {}, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - } - ] - }, - { - "description": "Updates egress firewall rule ", - "isasync": true, - "name": "updateEgressFirewallRule", - "params": [ - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "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 egress firewall rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the 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 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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" } ], - "type": "list" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - {}, - { - "description": "the 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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "type": "set" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the state of the virtual machine", + "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 password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Lists all supported OS categories for this cloud.", - "isasync": false, - "name": "listOsCategories", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list Os category by id", - "length": 255, + "description": "the ID of the virtual machine", "name": "id", - "related": "listOsCategories", - "required": false, - "type": "uuid" - }, - { - "description": "list os category by name", - "length": 255, - "name": "name", - "required": false, - "since": "3.0.1", - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the name of the OS category", - "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {}, { - "description": "the ID of the OS category", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists all available service offerings.", - "isasync": false, - "name": "listServiceOfferings", - "params": [ - { - "description": "the CPU speed that listed offerings must support", - "length": 255, - "name": "cpuspeed", - "required": false, - "since": "4.15", - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "id of zone disk offering is associated with", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "since": "4.13", - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "the CPU number that listed offerings must support", - "length": 255, - "name": "cpunumber", - "required": false, - "since": "4.15", - "type": "integer" - }, - { - "description": "the RAM memory that listed offering must support", - "length": 255, - "name": "memory", - "required": false, - "since": "4.15", - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "is this a system vm offering", - "length": 255, - "name": "issystem", - "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": "listed offerings support root disk encryption", - "length": 255, - "name": "encryptroot", - "required": false, - "since": "4.18", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "ID of the service offering", - "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", - "length": 255, - "name": "virtualmachineid", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": false, - "type": "uuid" - }, - { - "description": "name of the service offering", - "length": 255, - "name": "name", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", - "length": 255, - "name": "systemvmtype", - "required": false, - "type": "string" - } - ], - "related": "updateServiceOffering", - "response": [ - { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "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": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "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": "the storage type for this service offering", - "name": "storagetype", - "type": "string" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "name of the disk offering", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", "name": "diskofferingname", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - {}, - { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" - }, - { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "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 host tag for the service offering", - "name": "hosttags", - "type": "string" - }, - { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the name of the service offering", - "name": "name", - "type": "string" - }, - { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" - }, - { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "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", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" - }, - { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" - }, - { - "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", - "type": "integer" } - ] + ], + "since": "4.19.0" }, { - "description": "Assigns a VM to a backup offering", + "description": "Removes a load balancer rule association with global load balancer rule", "isasync": true, - "name": "assignVirtualMachineToBackupOffering", + "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "ID of the virtual machine", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "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": "loadbalancerrulelist", + "related": "", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "ID of the backup offering", + "description": "The ID of the load balancer rule", "length": 255, - "name": "backupofferingid", + "name": "id", "related": "", "required": true, "type": "uuid" @@ -130982,70 +139139,22 @@ "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ], - "since": "4.14.0" - }, - { - "description": "Removes a load balancer rule association with global load balancer rule", - "isasync": true, - "name": "removeFromGlobalLoadBalancerRule", - "params": [ - { - "description": "The ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "the list load balancer rules that will be assigned to global load balancer rule", - "length": 255, - "name": "loadbalancerrulelist", - "related": "", - "required": true, - "type": "list" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {} ] }, @@ -131080,21 +139189,21 @@ "response": [ {}, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } ] }, { @@ -131103,33 +139212,34 @@ "name": "listCapacity", "params": [ { - "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": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "recalculate capacities and fetch the latest", + "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": "fetchlatest", + "name": "type", "required": false, - "since": "3.0.0", - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "pagesize", + "name": "sortby", "required": false, - "type": "integer" + "since": "3.0.0", + "type": "string" }, { - "description": "List by keyword", + "description": "lists capacity by the Zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -131156,48 +139266,46 @@ "type": "uuid" }, { - "description": "lists capacity by the Zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Sort the results. Available values: Usage", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "sortby", + "name": "fetchlatest", "required": false, "since": "3.0.0", - "type": "string" + "type": "boolean" } ], "related": "", "response": [ - {}, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -131205,35 +139313,40 @@ "name": "capacitytotal", "type": "long" }, - {}, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, + {}, { - "description": "the capacity name", - "name": "name", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -131241,11 +139354,7 @@ "name": "percentused", "type": "string" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - } + {} ] }, { @@ -131263,11 +139372,19 @@ "type": "uuid" }, { - "description": "destination Cluster 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": "clusterid", - "related": "", + "name": "deploymentplanner", "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "required": true, "type": "uuid" }, { @@ -131278,14 +139395,6 @@ "required": false, "type": "uuid" }, - { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", - "type": "string" - }, { "description": "Boot into hardware setup menu or not", "length": 255, @@ -131303,150 +139412,618 @@ "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "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, + "name": "clusterid", + "related": "", + "required": false, "type": "uuid" } ], - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", "response": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the 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": "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "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" - } - ], - "type": "set" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the 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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "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 list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -131455,8 +140032,8 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -131464,28 +140041,23 @@ "name": "startport", "type": "integer" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the 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": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -131499,161 +140071,248 @@ "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 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": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "account owning the security group rule", - "name": "account", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "description": "the list of 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 account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "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": "account owning the security group rule", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "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": "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": "security group name", - "name": "securitygroupname", + "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 domain associated with the tag", + "name": "domain", + "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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" @@ -131662,43 +140321,38 @@ "description": "the ID of the security group", "name": "id", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "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 id of userdata used for the VM", - "name": "userdataid", + "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", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { @@ -131706,143 +140360,18 @@ "name": "domainid", "type": "string" }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "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 project ID of the affinity group", - "name": "projectid", + "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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -131856,18 +140385,23 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the type of the affinity group", + "name": "type", "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 domain name of the affinity group", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -131876,838 +140410,712 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "Updates a service offering.", + "isasync": false, + "name": "updateServiceOffering", + "params": [ { - "description": "the project name of the vm", - "name": "project", + "description": "the display text of the service offering to be updated", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the service offering to be updated", + "length": 255, + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the service offering to be updated", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, + "description": "sort key of the service offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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 user's name who deployed the virtual machine", - "name": "username", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the 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": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "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": "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - } - ], - "type": "set" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + {}, + { + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "is this a system vm offering", + "name": "issystem", "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": "Updates a service offering.", - "isasync": false, - "name": "updateServiceOffering", - "params": [ - { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, - "since": "4.16", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "the name of the service offering to be updated", - "length": 255, - "name": "name", - "required": false, + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "sort key of the service offering, integer", - "length": 255, - "name": "sortkey", - "required": false, + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the display text of the service offering to be updated", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", - "length": 255, - "name": "storagetags", - "required": false, - "since": "4.16", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the ID of the service offering to be updated", - "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, - {}, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { "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": "true if virtual machine needs to be dynamically scalable of cpu or memory", "name": "dynamicscalingenabled", "type": "boolean" + } + ] + }, + { + "description": "Stops a virtual machine.", + "isasync": true, + "name": "stopVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "required": true, + "type": "uuid" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, "type": "boolean" - }, + } + ], + "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "response": [ { - "description": "the 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 zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "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 disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" - }, - { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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 name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "io requests read rate of the service 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 name of the service offering", - "name": "name", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, + {}, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "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": "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": "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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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 number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - } - ] - }, - { - "description": "Stops a virtual machine.", - "isasync": true, - "name": "stopVirtualMachine", - "params": [ - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" - } - ], - "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ + "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": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "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" }, { @@ -132715,54 +141123,19 @@ "name": "vpcid", "type": "string" }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, { "description": "the name of the corresponding network", "name": "networkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -132776,28 +141149,23 @@ "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -132806,270 +141174,106 @@ "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", - "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", + "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 traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "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 domain name of the affinity group", - "name": "domain", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" } ], "type": "set" }, { - "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 ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "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", - "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { @@ -133077,23 +141281,23 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -133102,111 +141306,41 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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 name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the description of the security group", @@ -133214,24 +141348,14 @@ "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the 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", @@ -133242,33 +141366,13 @@ "name": "account", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -133277,83 +141381,98 @@ "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 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": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -133362,51 +141481,46 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "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 project name of the group", - "name": "project", - "type": "string" - }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -133415,44 +141529,49 @@ "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 ingress rules associated with the security group", - "name": "ingressrule", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the 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" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -133463,153 +141582,172 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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 account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "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": "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "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" } ], "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" } ], "type": "set" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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 ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, - { - "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" }, { - "description": "the 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 name of the host for the virtual machine", - "name": "hostname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -133618,89 +141756,118 @@ "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the 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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" } ] }, { - "description": "Creates a network ACL for the given VPC", + "description": "Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.", "isasync": true, "name": "createNetworkACLList", "params": [ { - "description": "Description of the network ACL list", + "description": "Name of the network ACL list", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, + { + "description": "ID of the VPC associated with this network ACL list", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" + }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -133710,40 +141877,20 @@ "type": "boolean" }, { - "description": "Name of the network ACL list", + "description": "Description of the network ACL list", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "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" } ], "related": "", "response": [ { - "description": "the Name of the ACL", - "name": "name", - "type": "string" - }, - { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the ID of the ACL", - "name": "id", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, - {}, { "description": "Description of the ACL", "name": "description", @@ -133755,22 +141902,34 @@ "type": "integer" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ACL", + "name": "id", + "type": "string" + }, + { + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { "description": "Id of the VPC this ACL is associated with", "name": "vpcid", "type": "string" - } + }, + { + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + {} ] } ], - "count": 739 + "count": 754 } diff --git a/test/AddressService_test.go b/test/AddressService_test.go index 9d534cd1..48009ec4 100644 --- a/test/AddressService_test.go +++ b/test/AddressService_test.go @@ -54,7 +54,7 @@ func TestAddressService(t *testing.T) { if _, ok := response["disassociateIpAddress"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Address.NewDisassociateIpAddressParams("id") + p := client.Address.NewDisassociateIpAddressParams() _, err := client.Address.DisassociateIpAddress(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/KubernetesService_test.go b/test/KubernetesService_test.go index e3dfbd44..3f609750 100644 --- a/test/KubernetesService_test.go +++ b/test/KubernetesService_test.go @@ -54,7 +54,7 @@ func TestKubernetesService(t *testing.T) { if _, ok := response["createKubernetesCluster"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Kubernetes.NewCreateKubernetesClusterParams("clustertype", "name", "zoneid") + p := client.Kubernetes.NewCreateKubernetesClusterParams("name", "zoneid") r, err := client.Kubernetes.CreateKubernetesCluster(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/NetworkACLService_test.go b/test/NetworkACLService_test.go index b20e352a..cfa70248 100644 --- a/test/NetworkACLService_test.go +++ b/test/NetworkACLService_test.go @@ -54,7 +54,7 @@ func TestNetworkACLService(t *testing.T) { if _, ok := response["createNetworkACLList"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.NetworkACL.NewCreateNetworkACLListParams("name", "vpcid") + p := client.NetworkACL.NewCreateNetworkACLListParams("name") r, err := client.NetworkACL.CreateNetworkACLList(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/TemplateService_test.go b/test/TemplateService_test.go index d1443ed3..555482ff 100644 --- a/test/TemplateService_test.go +++ b/test/TemplateService_test.go @@ -96,7 +96,7 @@ func TestTemplateService(t *testing.T) { if _, ok := response["getUploadParamsForTemplate"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Template.NewGetUploadParamsForTemplateParams("displaytext", "format", "hypervisor", "name", "zoneid") + p := client.Template.NewGetUploadParamsForTemplateParams("format", "hypervisor", "name", "zoneid") _, err := client.Template.GetUploadParamsForTemplate(p) if err != nil { t.Errorf(err.Error())